10Duke Event API

The 10Duke Event API enables access to 10Duke Enterprise event data.

This article provides a quick reference on the events generated by 10Duke Enterprise. The full data schema is available in the 10Duke GitHub repository.

Event format

Each event consists of an envelope and the actual event data. Depending on the event type, the envelope part provides details on the event such as the event type (like UserAuthenticated or LicenseProvisioned) and the ID of the source component that generated the event.

Example events

This example shows two events in JSON format. In each event, the data element contains the actual event data.

{
    "eventType": "UserAuthenticated",
    "eventSourceId": "example-idp",
    "data": {
        "eventTime": 1724242158854,
        "requestId": "62371613-5f76-4df2-b349-4f8c27932d9b",
        "userId": "6dcf45c9-87ed-42a6-9b0a-ac8494305904",
        "authenticatedId": "da058d15-d512-4703-84cd-9ae9692252f1",
        "remember": false,
        "authentications": [
            "password",
            "emailVerification",
            "acceptAgreements"
        ]
    },
    "version": "1.8.0"
}
{
    "eventType": "RequestProcessed",
    "eventObjectId": "6dcf45c9-87ed-42a6-9b0a-ac8494305904",
    "eventObjectType": "user",
    "eventSourceId": "example-idp",
    "data": {
        "eventTime": 1724242158904,
        "requestId": "5a9734ab-8f40-4b1d-a12f-f8a742b7f1db",
        "clientIpAddress": "1.2.3.4",
        "userAgent": "Example Client App 1.2.3",
        "method": "GET",
        "url": "https://login.example.com/user/oauth20/authz",
        "status": 302,
        "userId": "6dcf45c9-87ed-42a6-9b0a-ac8494305904",
        "technicalUser": false,
        "authenticatedSessionId": "b0371857-eb19-42e1-b245-e65fda2351a8",
        "clientApplicationId": "eabc490d-da1d-4ec3-89ec-423bd440b4b2",
        "clientApplicationType": "OAUTH20",
        "duration": 33
    },
    "version": "1.8.0"
}

Event types

The following sections provide an overview of the types of events that 10Duke Enterprise generates, organized into categories.

For details, see the event schema on GitHub.

User management events

This category contains events related to inviting and managing users in the system.

Event type	Description
`OrganizationInvitationRevoked`	A user’s invitation to an organization has been revoked.
`OrganizationInvitationSent`	A user’s invitation to an organization has been sent to the invitation recipient.
`OrganizationInvitationTokenGenerated`	A new invitation token has been generated for a user’s invitation to an organization.
`UserCreated`	User data has been created in the system, but activating an authentication mechanism is still required to create a working user account.
`UserDeleted`	A user account has been deleted from the system.
`UserInvitationRevoked`	An invitation to sign up as a user in the system has been revoked.
`UserInvitationSent`	An invitation to sign up as a user in the system has been sent to the invitation recipient.
`UserInvitationTokenGenerated`	A new invitation token has been generated for an invitation to sign up as a user.
`UserPasswordCreated`	A new password has been created for a user through the API.
`UserUpdated`	A user account has been updated.

User action events

This category contains events related to users’ signup, login, and authentication related actions.

Event type	Description
`ForgotPasswordEmailSent`	A “forgot password” or an “activate user account” email has been sent to a user.
`ForgotPasswordReset`	A user has set a new password for themselves using the “forgot password” or “activate user account” email.
`OrganizationInvitationAccepted`	A user has accepted an invitation to an organization.
`TokenIssued`	An OAuth 2.0 access token has been issued by 10Duke Enterprise.
`OrganizationInvitationDeclined`	A user has declined an invitation to an organization.
`UserAuthenticated`	A user has been authenticated (has logged in).
`UserEmailChanged`	A user’s email address has been changed.
`UserInvitationAccepted`	A user has accepted an invitation to sign up as a user in the system.
`UserInvitationDeclined`	A user has declined an invitation to sign up as a user in the system.
`UserLoggedOut`	A user has logged out.
`UserMfaActivated`	A user has activated two-factor authentication (2FA) for their user account by connecting a multi-factor authentication (MFA) device.
`UserMfaDeactivated`	A user has deactivated 2FA for their user account.
`UserPasswordChanged`	A user has changed their password.
`UserRecoveryEmailAdded`	A user has added a recovery email address for their user account.
`UserRegistered`	A user has registered in the system and a user account has been created.

License provisioning events

This category contains events related to provisioning licenses to organizations and users.

Event type	Description
`LicenseProvisioned`	A new license has been created, or credit has been added to an existing license.

License management events

This category contains events related to managing users’ seat reservations and blockings for organization licenses.

Event type	Description
`LicenseConsumptionAllowed`	A user’s blocking for a license has been removed.
`LicenseConsumeDenied`	A user has been blocked from using a license.
`LicenseReserved`	A seat reservation has been made for a user.
`LicenseReservationReleased`	A user’s seat reservation has been released.

License consumption events

This category contains events related to the consumption of organization licenses by users and device clients, and the consumption of personal licenses by users.

Event type	Description
`LicenseChecked`	A license’s availability has been checked through the License Consumption API but the license has not been consumed.
`LicenseConsumed`	A license’s consumption has started and a license lease has been created.
`LicenseReleased`	A license’s consumption has ended by releasing the lease.

Technical events

This category contains technical events.

Event type	Description
`RequestProcessed`	A request has been processed.

Audit events

This category contains events that provide an audit trail of CRUD actions in the system.

Event type	Description
`Created`	An entity has been created in the system.
`Updated`	An entity has been updated.
`Deleted`	An entity has been deleted from the system.