Events

This section describes the events generated by ActivID CMS to which the Event Notification plug-in SPI can respond. Each event listed in this section provides a table that lists and describes the attributes for each event by identifying the following:

  • Field name

  • Value

  • Description

Device Management Events

This section describes the events associated with device management, and lists the events and related event attributes in tables.

This event occurs after any one of the following actions is completed:

  • A device is issued locally.

  • A post-issuance request for a device is executed.

  • A validated issuance request is executed.

Attributes

The following table describes the related attributes.

Device Contents Updated Events Attributes

Field

Value

Description

EventID

10001

Unique event identifier.

Description

<CardIssuance>

The Device Issuance event occurs after any of the following actions is completed:

  • A device is issued locally.

  • A device is re-issued.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<TemporaryCardFlag>

Flag indicating whether device is a temporary device, with the following possible values:
0 = permanent device
1 = temporary device

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<UserID>

Value of the attribute uniquely identifying the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is generated just before a post-issuance request is processed.

Attributes

The following table describes the related attributes.

Post-Issuance Request About to be Executed Event Attributes

Field

Value

Description

EventID

10002

Unique event identifier.

Description

<CardUpdate>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<NewCardPolicy>

Name of the new device policy (target policy).

AdditionalInfoChar3

<OldCardPolicy>

Name of the initial device policy.

This event occurs after a device has been assigned to a user.

Attributes

The following table describes the related attributes.

Device Binding Complete Event Attributes

Field

Value

Description

EventID

10003

Unique event identifier.

Description

<CardBind>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>, <CardPolicy>

String containing the device type and the name of the device policy, separated by a comma (,) when specified; otherwise it is null.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<UserID>

Value of the attribute uniquely identifying the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is generated after a device is unassigned from a user.

Attributes

The following table describes the related attributes.

Device has been Unbound Event Attributes

Field

Value

Description

EventID

10004

Unique event identifier.

Description

<CardUnbind>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<UserID>

Value of the attribute that uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is generated just after recycling a device.

Attributes

The following table describes the related attributes.

Device is About to be Recycled Event Attributes

Field

Value

Description

EventID

10005

Unique event identifier.

Description

<CardRecycle>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event is sent just after a device is terminated.

Attributes

The following table describes the related attributes.

Device has been Terminated Event Attributes

Field

Value

Description

EventID

10006

Unique event identifier.

Description

<Terminate>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<TerminationReason>

Reasons why this device has been terminated include:

  • UNASSIGNED: The Help Desk operator terminated the device using the Terminate function.

  • STOLEN: The device is defined as stolen.

  • LOST: The device is defined as lost.

  • DAMAGED: The device is defined as damaged.

  • EXPIRED: The device is defined as expired.

AdditionalInfoChar3

<UserID>

Value of the attribute that unique identifies the user in the directory.

This event occurs just before unlocking a device.

Attributes

The following table describes the related attributes.

Device is About to be Unlocked Event Attributes

Field

Value

Description

EventID

10007

Unique event identifier.

Description

<RequestUnlock>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<UserID>

Value of the attribute that uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is created after a request for a replacement device is submitted.

Attributes

The following table describes the attributes.

Replacement Device Requested Event Attributes

Field

Value

Description

EventID

10008

Unique event identifier.

Description

<Replace>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<ReplacementReason>

Reasons why this device is being replaced include:

  • FORGOTTEN: The device is defined as forgotten.

  • STOLEN: The device is defined as stolen.

  • LOST: The device is defined as lost.

  • DAMAGED: The device is defined as damaged.

  • EXPIRED: The device is defined as expired.

AdditionalInfoChar3

<UserID>

Value of the attribute uniquely identifies the user in the directory.

This event occurs after a device is suspended.

Attributes

The following table describes the related attributes.

Device has been Suspended Event Attributes

Field

Value

Description

EventID

10009

Unique event identifier.

Description

<SuspendDevice>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<TemporaryCardFlag>

Flag indicates the current device status (temporary or permanent values):

0 = Permanent device

1 = Temporary device

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

<UserID>

Value of the attribute uniquely identifies the user in the directory.

This event is generated after a device is resumed.

Attributes

The following table describes the related attributes.

Device has been Resumed Event Attributes

Field

Value

Description

EventID

10010

Unique event identifier.

Description

<ResumeDevice>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<TemporaryCardFlag>

Flag indicates the current device status (temporary or permanent values):

0 = Permanent device

1 = Temporary device

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

<UserID>

Value of the attribute uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is triggered upon logical activation of a device in ActivID CMS.

Attributes

The following table describes the related attributes.

Device Activated Event Attributes

Field

Value

Description

EventID

10011

Unique event identifier.

Description

<ActivateDevice>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<TemporaryCardFlag>

Flag indicates the current device status (temporary or permanent values):

0 = Permanent device

1 = Temporary device

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

<UserID>

Value of the attribute uniquely identifies the user in the directory.

The device synchronized event is generated by ActivID CMS after a pending request has been synchronized.

Attributes

The following table describes the related attributes.

Device Synchronized Event Attributes

Field

Value

Description

EventID

100121

Unique event identifier.

Description

<SynchronizeDevice>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID> or <UserID>

When the workflow is driven from the ActivID CMS Administrator console, this attribute contains the subject name of the operator’s certificate used to authenticate to ActivID CMS.

However, if the user caused synchronization to occur in the ActivID CMS User Portal, the value of this attribute uniquely identifies the user in the directory.

AdditionalInfoNum1

<RequestID>

ID of the request that was synchronized.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

<RequestType>

Indicates the type of request that was synchronized:

1 = Temporary replacement

2 = Permanent replacement

3 = Re-issuance

4 = Validated issuance

8 = PIN unlock

32 = Applications update

64 = Issuance

66 = Recycle

128 = Production

256 = Card manager lock/unlock

AdditionalInfoChar2

<UserID>

Value of the attribute uniquely identifies the user in the directory.

AdditionalInfoChar3

<TemporaryCardFlag>

Flag indicates the current device status (temporary or permanent values):

0 = Permanent device

1 = Temporary device

Credential Management Events

Credential management events are grouped in the following way:

  • Event IDs 20001 through 20999 are generated for credentials that are not managed by credential providers that implement the ActivID CMS Credential Provider SPI.

  • Event IDs 21001 through 21999 are generated for credentials that are managed by credential providers that implement the ActivID CMS Credential Provider SPI.

Any integration that requires the notification for all kinds of credentials must support both of these ranges of events.

This event occurs whenever the unlock code (response) is computed by ActivID CMS. This event is generated for credentials that not managed by credential providers that implement the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Unlock Code Computed Event Attributes

Field

Value

Description

EventID

20001

Unique event identifier.

Description

<GetUnlockCode>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<CardType>

Type of device.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event is generated after a credential is revoked. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Revoked Event Attributes

Field

Value

Description

EventID

20002

Unique event identifier.

Description

<CertRevoke>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Revoked Event

SKI: see SKI Credential Revoked Event

AdditionalInfoChar1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Revoked Event

SKI: see SKI Credential Revoked Event

AdditionalInfoNum2

<CredentialType>

Indicates the type of credential being revoked:

0 = PKI

1 = SKI

AdditionalInfoChar2

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Revoked Event

SKI: see SKI Credential Revoked Event

AdditionalInfoChar3

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Revoked Event

SKI: see SKI Credential Revoked Event

These are the values of the additional information attributes of the event object when a Public Key Infrastructure (PKI) credential has been revoked.

Attributes

The following table describes the related attributes.

PKI Credential Revoked Event Attributes

Field

Value

Description

AdditionalInfoNum1

<CertificateType>

Type of certificates can include the following:

1 = Microsoft Certificate Authority

2 = Entrust Authority

4 = OpenTrust PKI (IdealX) Authority

5 = Symantec MPKI 8.0 Authority

8 = IdenTrust Certificate Authority

9 = VCI credentials support

10 = HID PKI-as-a-Service Certificate Authority

13 = Keyfactor EJBCA

Note: This list may vary based on your specific installation. The items above correspond to a new installation of version 6.3. On older installations, you can refer to the content of the AIMSEE.CONFIGURATION_CFG table.

AdditionalInfoChar1

<CertSubject>

Indicates the certificate subject (truncated to 64 bytes).

AdditionalInfoChar2

<CardType>,<CertSN>

String containing the device type and certificate serial number, in a format where they are separated by a comma (,).

AdditionalInfoChar3

<CALogicalName>

Logical name of the certificate authority (CA) that revoked the certificate.

These are the values of the additional information attributes of an event object when a Symmetric Key Infrastructure (SKI) credential event has been revoked.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Revoked Event Attributes

Field

Value

Description

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as ActivID AAA Server) that revoked the SKI credential.

AdditionalInfoChar2

<CardType>,<CertSN>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event is generated after a credential is suspended. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Suspended Event Attributes

Field

Value

Description

EventID

20003

Unique event identifier.

Description

<CertHold>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Suspended Event

SKI: see SKI Credential Suspended Event

AdditionalInfoChar1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Suspended Event

SKI: see SKI Credential Suspended Event

AdditionalInfoNum2

<CredentialType>

Indicates the type of credential being suspended:

0 = PKI

1 = SKI

AdditionalInfoChar2

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Suspended Event

SKI: see SKI Credential Suspended Event

AdditionalInfoChar3

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Suspended Event

SKI: see SKI Credential Suspended Event

These are the values of the additional information attributes of an event object when a PKI credential is suspended.

Attributes

The following table describes the related attributes.

PKI Credential Suspended Event Attributes

Field

Value

Description

AdditionalInfoNum1

<CertificateType>

Type of certificates can include the following:

1 = Microsoft Certificate Authority

2 = Entrust Authority

4 = OpenTrust PKI (IdealX) Authority

5 = Symantec MPKI 8.0 Authority

8 = IdenTrust Certificate Authority

9 = VCI credentials support

10 = HID PKI-as-a-Service Certificate Authority

13 = Keyfactor EJBCA

Note: This list may vary based on your specific installation. The items above correspond to a new installation of version 6.3. On older installations, you can refer to the content of the AIMSEE.CONFIGURATION_CFG table.

AdditionalInfoChar1

<CertSubject>

Indicates the certificate subject (truncated to 64 bytes).

AdditionalInfoChar2

<CardType>,<CertSN>

String containing the device type and certificate serial number, in a format where they are separated by a comma (,).

AdditionalInfoChar3

<CALogicalName>

Logical name of the certificate authority (CA) that suspended the certificate.

These are the values of the additional information attributes of an event object when an SKI credential event is suspended.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Suspended Event Attributes

Field

Value

Description

AdditionalInfoNum1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as ActivID AAA Server) that suspended the SKI credential.

AdditionalInfoChar2

<CardType>,<CertSN>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event is generated after a credential is resumed. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Resumed Event Attributes

Field

Value

Description

EventID

20004

Unique event identifier.

Description

<CertResume>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Resumed Event

SKI: see SKI Credential Resumed Event

AdditionalInfoChar1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Resumed Event

SKI: see SKI Credential Resumed Event

AdditionalInfoNum2

<CredentialType>

Indicates the type of credential being resumed:

0 = PKI

1 = SKI

AdditionalInfoChar2

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Resumed Event

SKI: see SKI Credential Resumed Event

AdditionalInfoChar3

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Resumed Event

SKI: see SKI Credential Resumed Event

These are the values of the additional information attributes of an event object when a PKI credential is resumed.

Attributes

The following table describes the related attributes.

PKI Credential Resumed Event Attributes

Field

Value

Description

AdditionalInfoNum1

<CertificateType>

Type of certificates can include the following:

1 = Microsoft Certificate Authority

2 = Entrust Authority

4 = OpenTrust PKI (IdealX) Authority

5 = Symantec MPKI 8.0 Authority

8 = IdenTrust Certificate Authority

9 = VCI credentials support

10 = HID PKI-as-a-Service Certificate Authority

13 = Keyfactor EJBCA

Note: This list may vary based on your specific installation. The items above correspond to a new installation of version 6.3. On older installations, you can refer to the content of the AIMSEE.CONFIGURATION_CFG table.

AdditionalInfoChar1

<CertSubject>

Indicates the certificate subject (truncated to 64 bytes).

AdditionalInfoChar2

<CardType>,<CertSN>

String containing the device type and certificate serial number, in a format where they are separated by a comma (,).

AdditionalInfoChar3

<CALogicalName>

Logical name of the certificate authority (CA) that resumed the certificate.

These are the values of the additional information attributes of an event object when an SKI credential event is resumed.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Resumed Event Attributes

Field

Value

Description

AdditionalInfoNum1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as ActivID AAA Server) that resumed the SKI credential.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event is generated when a credential issuance request is created, just before it is sent to the repository (for example a CA or an ActivID AAA Server). This event is generated for credentials that are not managed by credential providers that implement the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Request Created Event Attributes

Field

Value

Description

EventID

20007

Unique event identifier.

Description

<CredentialRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<DeviceSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Request Created Event

SKI: see SKI Credential Request Created Event

AdditionalInfoChar1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Request Created Event

SKI: see SKI Credential Request Created Event

AdditionalInfoNum2

<CredentialType>

Indicates the type of credential being resumed:

0 = PKI

1 = SKI

AdditionalInfoChar2

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Request Created Event

SKI: see SKI Credential Request Created Event

AdditionalInfoChar3

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Request Created Event

SKI: see SKI Credential Request Created Event

These are the values of the additional information attributes of an event object when a PKI credential is created.

Attributes

The following table describes the related attributes.

PKI Credential Request Created Event Attributes

Field

Value

Description

AdditionalInfoNum1

<CertificateType>

Type of certificates can include the following:

1 = Microsoft Certificate Authority

2 = Entrust Authority

4 = OpenTrust PKI (IdealX) Authority

5 = Symantec MPKI 8.0 Authority

8 = IdenTrust Certificate Authority

9 = VCI credentials support

10 = HID PKI-as-a-Service Certificate Authority

13 = Keyfactor EJBCA

Note: This list may vary based on your specific installation. The items above correspond to a new installation of version 6.3. On older installations, you can refer to the content of the AIMSEE.CONFIGURATION_CFG table.

AdditionalInfoChar1

<CertSubject>

Indicates the certificate subject.

AdditionalInfoChar2

<CardType>

Type of device.

AdditionalInfoChar3

<CALogicalName>

Logical name of the certificate authority (CA) that issues the certificate.

These are the values of the additional information attributes of an event object when an SKI credential event is created.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Request Created Event Attributes

Field

Value

Description

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as the ActivID AAA Server) that issues the SKI credential.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is generated when a credential is issued. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Issued Event Attributes

Field

Value

Description

EventID

20008

Unique event identifier.

Description

<CredentialRequest>

Describes the event taking place.

Status

<CredentialIssued>

Status indicating whether the operation was successful, with the following possible values:

0 = Success

1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Issued Event

SKI: see SKI Credential Issued Event

AdditionalInfoNum2

<CredentialType>

Indicates the type of credential being resumed:

0 = PKI

1 = SKI

6 = Emergency Password (for SKI only)

AdditionalInfoChar1

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Issued Event

SKI: see SKI Credential Issued Event

AdditionalInfoChar2

<CredentialType>

Depends on the credential type in use:

PKI: see PKI Credential Issued Event

SKI: see SKI Credential Issued Event

AdditionalInfoChar3

Dependent on credential type

Depends on the credential type in use:

PKI: see PKI Credential Issued Event

SKI: see SKI Credential Issued Event

These are the values of the additional information attributes of an event object when a PKI credential is issued.

Attributes

The following table describes the related attributes.

PKI Credential Issued Event Attributes

Field

Value

Description

AdditionalInfoNum1

<CertificateType>

Type of certificates can include the following:

1 = Microsoft Certificate Authority

2 = Entrust Authority

4 = OpenTrust PKI (IdealX) Authority

5 = Symantec MPKI 8.0 Authority

8 = IdenTrust Certificate Authority

9 = VCI credentials support

10 = HID PKI-as-a-Service Certificate Authority

13 = Keyfactor EJBCA

Note: This list may vary based on your specific installation. The items above correspond to a new installation of version 6.3. On older installations, you can refer to the content of the AIMSEE.CONFIGURATION_CFG table.

AdditionalInfoChar1

<CertSubject>

Indicates the certificate subject.

AdditionalInfoChar2

<CardType>, <CertSN>,

<StartValidityPeriod>,

<EndValidityPeriod>,

<CertRequestId>

The following information is present in this attribute:

  • Device type

  • Serial number of issued certificate

  • Start of the certificate validity period (date format)

  • End of the certificate validity period (date format)

  • ID of the certificate request if the certificate was issued by a Microsoft CA

AdditionalInfoChar3

<CALogicalName>

Logical name of the certificate authority (CA) that issues the certificate.

These are the values of the additional information attributes of an event object when an SKI credential is issued.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Issued Event Attributes

Field

Value

Description

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as ActivID AAA Server) that issued the SKI credential.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

CredentialValue

<SKICredentialObject>

Object describing the SKI credential. The CredentialValue attribute is present in the event only if:

  • It is in the AP_PROPERTIES table (defined in the AIMSEE database)

  • Value is associated with the (and is equal to Yes) AMS.SKI.NotifyCredentialValue (the default installation of ActivID CMS does not set this value).

ActivID CMS must be restarted if this value is changed.

The SKI credential object is an instance of the Java Hashtable class. The following table describes the keys of the Hashtable object.

Note:  

  • The values in the SKI credential object are not encrypted.

  • Only for ActivID AAA Server.

SKI Credential Object Keys

Key

Type

Description

syncDesAlgorithmVersion

String

Algorithm version (DES/DES3).

SyncDesKey

String

Value of the synchronous authentication key.

syncDeviceMaskVersion

Integer

Device mask type.

syncResponseFormat

Integer

Response format in either of following types:

  • 0 = Decimal

  • 1 = Hexadecimal

syncResponseLength

Integer

Length of the One-Time Password (OTP).

syncUseCheckDigitOnResponse

Integer

Indicates if the response contains a check digit (0/1).

syncAuthenticationCounterValue

Integer

Authentication counter value.

syncClockExtractBitNumber

Integer

Number of extraction bits of the clock.

syncDerivationMode

Integer

Key derivation mode is On (0/1).

syncDeviceOffset

Integer

Device offset.

syncIncrementCounterOnSuccess

Integer

Indicates if the counter value is updated on success (0/1).

asyncDesKey

String

Value of the asynchronous authentication key.

asyncDesAlgorithmVersion

String

Algorithm version (DES/DES3).

asyncUseCheckDigitOnChallenge

Integer

Flag for response check digit (0/1).

asyncResponseFormat

Integer

Response format in either of following types:

  • 0 = Decimal

  • 1 = Hexadecimal

asyncResponseLength

Integer

Size of response.

asyncLastChallenge

String

Last used challenge.

These are the values of the additional information attributes of the event object when an SKI emergency access password is issued. The emergency password temporarily replaces One-Time Passwords (OTPs) when the user has forgotten or lost his or her device.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Issued Event Attributes

Field

Value

Description

AdditionalInfoNum1

0

Not used.

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Indicates the logical name of the AAA Administration server (such as ActivID AAA Server) in which the emergency password is created.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

CredentialValue

<EmergencyPasswordObject>

Object describing the emergency password. The CredentialValue attribute is present in the event only if:

  • It is in the AP_PROPERTIES table (defined in the AIMSEE database)

  • Value is associated with the (and is equal to Yes) AMS.SKI.NotifyCredentialValue (the default installation of ActivID CMS does not set this value).

ActivID CMS must be restarted if this value is changed.

See Emergency Password Object Description for a description of the structure of the object.

The emergency password object is an instance of the Java Hashtable class. The keys for accessing the Hashtable object are listed in the following table.

Note: The values in the emergency password object are not encrypted.
Emergency Password Object Keys

Key

Type

Description

passwordType

Integer

Emergency password types with the following possible values:

  • 1 = Temporary password

  • 2 = LDAP password

ValidityDate

Long

Represents the specified number of milliseconds (ms) since the standard base time known as the epoch; January 1, 1970, 00:00:00 Greenwich Mean Time (GMT).

EmergencyPasswordValue

String

Value for the emergency password. Note that the EmergencyPasswordValue key is not present in the Hashtable object if the emergency password is the same as the LDAP password.

This event is generated when an emergency password is deactivated. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Emergency Password Deactivated Event Attributes

Field

Value

Description

EventID

20009

Unique event identifier.

Description

<CredDelete>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

<CredentialType>

Type of credential deactivated. The only supported value is 6 (emergency password for SKI).

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Logical name of the AAA Administration server (such as ActivID AAA Server) used to deactivate the emergency password.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

null

Not used.

This event is generated just after an SKI credential is resynchronized. This event is generated for credentials that are not managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Note: Only for ActivID AAA Server.

Attributes

The following table describes the related attributes.

SKI Credential Synchronized Event Attributes

Field

Value

Description

EventID

20010

Unique event identifier.

Description

<CredSynchronize>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

<SynchronizationType>

Type of synchronization, with the following possible values:

  • 0 = by Counter

  • 1 = by Password (for future use only)

AdditionalInfoChar1

<AAAAdminServerLogicalName>

Logical name of the AAA Administration server (such as ActivID AAA Server) used to resynchronize the credential.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<SynchronizationValue>

Values used for synchronization, with the following possible types:

  • Counter if SynchronizationType is 0

  • One-Time Password (OTP) if SynchronizationType is 1

This event is generated before the execution of a request to create a credential, just before the request is sent to the credential provider. This event is generated for credentials that are managed by credential providers that are implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Create Credential Event Attributes

Field

Value

Description

EventID

21001

Unique event identifier.

Description

<CredProvCreateCredential>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

null

Not used.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

This event is generated before the execution of a request to update a credential, just before it is sent to the credential provider. This event is generated for credentials that are managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Update Credential Event Attributes

Field

Value

Description

EventID

21002

Unique event identifier.

Description

<CredProvUpdateCredential>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

<Action>

Update action to be performed on the credential.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

CredentialValues: com.actividentity. provider.cred.status

<CredentialStatus>

Current credential status.

This event is generated before the execution of a request to perform a lifecycle process on a credential before it is sent to the credential provider. This event is generated for credentials that are managed by credential providers implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Process Event Attributes

Field

Value

Description

EventID

21003

Unique event identifier.

Description

<CredProvProcessCredential>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

<Process>

Lifecycle process to be performed on the credential.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

CredentialValues: com.actividentity. provider.cred.status

<CredentialStatus>

Current credential status.

This event is generated after the execution of a request to create a credential. This event is generated for credentials that are managed by credential providers that are implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Created Event Attributes

Field

Value

Description

EventID

21011

Unique event identifier.

Description

<CredProvProcessCredential>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

null

Not used.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

If successful: CredentialValues: com.actividentity. provider.cred.status

<CredentialStatus>

Current credential status.

If Credential type = PKI and successful: CredentialValues: com.actividentity. provider.cred.pki.certificate

<PKIcertificate>

Base64-encoded certificate.

This event is generated after the execution of a request to update a credential after the credential is completed by the credential provider. This event is generated for credentials that are managed by credential providers that are implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Updated Event Attributes

Field

Value

Description

EventID

21012

Unique event identifier.

Description

<CredProvCredentialUpdated>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

<Action>

Update action performed on the credential.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

If successful: CredentialValues: com.actividentity. provider.cred.status

<CredentialStatus>

Current credential status.

If Credential type = PKI and successful: CredentialValues: com.actividentity. provider.cred.pki.certificate

<PKIcertificate>

Base64-encoded certificate.

This event is generated after the execution of a request to perform a lifecycle process on a credential after the credential is completed by the credential provider. This event is generated for credentials that are managed by credential providers that are implementing the ActivID CMS Credential Provider SPI.

Attributes

The following table describes the related attributes.

Credential Processed Event Attributes

Field

Value

Description

EventID

21013

Unique event identifier.

Description

<CredProvCredentialUpdated>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable (<type>:<serial number>).

OperatorID

<OperatorID>

Operator identifier.

AdditionalInfoNum1

<CredentialProviderID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<CredentialProviderContextID>

Unique identifier for the Credential Provider Context.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<CredentialType>

Identifies the credential type.

Note: One of PKI, SKI, or OATH (SKI and OATH for ActivID Authentication Server).

AdditionalInfoChar3

<Process>

Lifecycle process performed on the credential.

CredentialValues: com.actividentity. provider/profileId

<CredProfileID>

Unique identifier for the Credential profile.

If successful: CredentialValues: com.actividentity. provider.cred.status

<CredentialStatus>

Current credential status.

If Credential type = PKI and successful: CredentialValues: com.actividentity. provider.cred.pki.certificate

<PKIcertificate>

Base64-encoded certificate.

Request Management Events

This section describes the events associated with request management, and lists the events and related event attributes in the following tables.

This event is generated just after a request is created.

Attributes

The following table describes the related attributes.

Request Submitted Event Attributes

Field

Value

Description

EventID

30001

Unique event identifier.

Description

<WriteRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<RequestID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<RequestType>

Type of request:

  • 1 = Temporary replacement

  • 2 = Permanent replacement

  • 3 = Re-issuance

  • 4 = Validated issuance

  • 8 = Unlock

  • 32 = Application update

  • 64 = Issuance

  • 66 = Recycle

  • 128 = Production

  • 256 = Card manager lock/unlock

AdditionalInfoChar1

null

Not used.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event occurs when a request is approved. Notification occurs only if there is a formal approval of the request. There is no event when the request is approved automatically by the system (for example, for a request for an unlock or for a post-issuance request).

Attributes

The following table describes the related attributes.

Request Approved Event Attributes

Field

Value

Description

EventID

30002

Unique event identifier.

Description

<ApproveRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<RequestID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<RequestType>

Type of request:

  • 1 = Temporary replacement

  • 2 = Permanent replacement

  • 3 = Re-issuance

  • 4 = Validated issuance

  • 8 = Unlock

  • 32 = Application update

  • 64 = Issuance

  • 66 = Recycle

  • 128 = Production

  • 256 = Card manager lock/unlock

AdditionalInfoChar1

<ApprovedBy>

Name of the operator who approved the request.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event occurs when a request is denied.

Attributes

The following table describes the related attributes.

Request Denied Event Attributes

Field

Value

Description

EventID

30003

Unique event identifier.

Description

<DenyRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<RequestID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

<RequestType>

Type of request:

  • 1 = Temporary replacement

  • 2 = Permanent replacement

  • 3 = Re-issuance

  • 4 = Validated issuance

  • 8 = Unlock

  • 32 = Application update

  • 64 = Issuance

  • 66 = Recycle

  • 128 = Production

  • 256 = Card manager lock/unlock

AdditionalInfoChar1

null

Not used.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event occurs when a request is deleted by the system, after the request is successfully processed (for example, after an unlock request executes).

Attributes

The following table describes the related attributes.

Request Deleted Event Attributes

Field

Value

Description

EventID

30004

Unique event identifier.

Description

<DeleteRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<RequestID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

null

Not used.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

This event is generated when a request is cancelled.

Attributes

The following table describes the related attributes.

Request Canceled Event Attributes

Field

Value

Description

EventID

30005

Unique event identifier.

Description

<CancelRequest>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

<RequestID>

Unique identifier for the Credential Provider.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

null

Not used.

AdditionalInfoChar2

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar3

<CardType>

Type of device.

User Management Events

This section describes the events associated with user management, and lists the events and related event attributes in the following tables.

This event is generated when a user is added to the directory with ActivID CMS.

Attributes

The following table describes the related attributes.

User Created Event Attributes

Field

Value

Description

EventID

40001

Unique event identifier.

Description

<CreateUser>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory; null if not applicable.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event is generated when a user is deleted from the directory with ActivID CMS.

Attributes

The following table describes the related attributes.

User Deleted Event Attributes

Field

Value

Description

EventID

40002

Unique event identifier.

Description

<DeleteUser>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory; null if not applicable.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event is generated when a user is terminated.

Attributes

The following table describes the related attributes.

User Terminated Event Attributes

Field

Value

Description

EventID

40005

Unique event identifier.

Description

<TerminateUser>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory; null if not applicable.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event occurs when an ActivID CMS operator is enrolled or when the definition of an operator is updated.

Attributes

The following table describes the related attributes.

Operator Enrolled Event Attributes

Field

Value

Description

EventID

40003

Unique event identifier.

Description

<WriteOperator>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<OperatorName>

Name of the created/updated operator.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

This event occurs when an ActivID CMS operator is deleted.

Attributes

The following table describes the related attributes.

Operator Deleted Event Attributes

Field

Value

Description

EventID

40004

Unique event identifier.

Description

<DeleteOperator>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID>

Subject name of the certificate of the operator used to authenticate to ActivID CMS.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<OperatorName>

Name of the deleted operator.

AdditionalInfoChar2

null

Not used.

AdditionalInfoChar3

null

Not used.

Authentication Events

This section describes the events associated with authentication, and lists the events and related event attributes in the following tables.

This event is generated when a user logs into ActivID CMS User Portal.

Attributes

The following table describes the related attributes.

User-Authenticated Event Attributes

Field

Value

Description

EventID

50001

Unique event identifier.

Description

<AuthenticateUser>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred.

OperatorID

null

Not used.

AdditionalInfoNum1

<AuthenticationType>

Indicates the authentication type used to log in:

  • 0 = PIN

  • 1 = LDAP Password

  • 2 = Emergency Password

  • 3 = Security Questions (Memorable Data)

  • 4 = Initial Password

  • 5 = FIPS 196 (AES)

AdditionalInfoNum2

<LastLoginFlag>

Flag indicating whether this was the last login attempt before the

account is locked, which includes:

  • 0 = No

  • 1 = Yes (at this point the account is now locked).

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<URL>

Indicates the URL of User Portal.

AdditionalInfoChar3

null

Not used.

This event is generated when an operator logs into the ActivID CMS Operator Portal or using either the CCM-API or the REST API.

Attributes

The following table describes the related attributes.

Operator-Authenticated Event Attributes

Field

Value

Description

EventID

50002

Unique event identifier.

Description

<AuthenticateOperator>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

<CardSN>

Serial number of the device for which the event occurred; null if not applicable.

OperatorID

null

Not used.

AdditionalInfoNum1

<AuthenticationType>

Authentication type used to log in; the only supported type is 0 (zero) which represents PKI-based authentication.

AdditionalInfoNum2

0

Not used.

AdditionalInfoChar1

<OperatorID>

Subject name of the operator’s certificate used to authenticate to ActivID CMS.

AdditionalInfoChar2

<URL>

URL of the ActivID CMS Operator Portal.

AdditionalInfoChar3

<OperatorRole>

Role of the operator; in ActivID CMS, the following types of roles are supported:

  • Administrator

  • Operator

  • Help Desk

This parameter matches one of the roles configured using the ActivID CMS Graphical User Interface (GUI). Null is displayed if the operator is not enrolled in ActivID CMS.

Workflow Events

This section describes the events associated with workflow, and lists the events and related event attributes in the following tables.

Generic Plug-In Invoked Event

A notification event is triggered by ActivID CMS after a generic plug-in—either server or client—is invoked.

Attributes

The following table describes the related attributes.

Generic Plug-In Invoked Event Attributes

Field

Value

Description

EventID

40006

Unique event identifier.

Description

<InvokePlugins>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID> or <UserId>

The value can be either of the following choices:

  • When the workflow is driven from the ActivID CMS administrator console, this attribute contains the subject name of the operator’s certificate used to authenticate to ActivID CMS;

  • If the user caused synchronization to occur in the ActivID CMS User Portal, the value of the attribute uniquely identifies the user in the directory.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

<LogicalStepType>

The type of logical step that is processed can be either of the following values:

  • 0 = server-side logical step

  • 1 = client-side logical step

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<LogicalStepID>

The ID of the logical step that was processed (see Logical Step IDs Returned by Event Object).

AdditionalInfoChar3

<Plug-InID>

If no error occurred, value is null. Otherwise, the value is the ID of the plug-in that failed during execution.

The attributes of the generic plug-in invoked notification event are set after a server generic plug-in has been invoked, and include the following:

  • AdditionalInfoNum2: this value is 0 (server-side).

  • AdditionalInfoChar3: this value is null if no error occurred; otherwise, this value is the ID of the server plug-in that failed during execution.

The attributes of the generic plug-in invoked notification event are set after a client generic plug-in has been invoked, and include the following:

  • AdditionalInfoNum2: this value is 1 (client-side).

  • AdditionalInfoChar3: this value is null if no error occurred; otherwise, this value is the ID of the client plug-in that failed during execution.