UAM Schema

Universal audit model (UAM) is Immuta's consistent structure for all Immuta system and user query audit logs. This reference guide provides example schemas of all the UAM events available in Immuta.

There are some parameter details throughout to help better understand the UAM schemas. But there are two important parameters to each event:

  • targetType: Informs the Immuta object that's the target of the action being audited. This will specify if it was a user, project, policy, etc. being affected by the action.

  • action: Informs the base action being performed on the target. This will specify if something was created, deleted, updated, etc.

To learn more about Immuta's audit, see the UAM reference page or view the examples below.

Events and descriptions

Immuta object
Events
Descriptions

API keys

Audit events for managing API keys.

Attributes

Audit events for managing attributes.

Configuration

An audit event for Immuta configuration changes.

Domains

Audit events for managing domains, domain policies, and domain permissions.

Groups

Audit events for managing Immuta groups and group members.

License

Audit events for managing Immuta licenses.

Local policies

Audit events for managing local policies.

Permissions

Audit events for managing user permissions.

Policy adjustments

Audit events for managing policy adjustments in a project.

Purposes

Audit events for managing purposes.

Queries

Audit events for user queries within data platforms.

Tags

Audit events for managing tags and their application.

Webhooks

Audit events for managing webhooks.

ApiKeyCreated event

  • Event: ApiKeyCreated

  • Legacy event: apiKey

  • Description: An audit event for when an API key is created on the Immuta app settings page or from an Immuta user's profile page.

ApiKeyDeleted event

  • Event: ApiKeyDeleted

  • Legacy event: apiKey

  • Description: An audit event for when an API key is deleted on the Immuta app settings page or from an Immuta user's profile page.

AttributeApplied event

  • Event: AttributeApplied

  • Legacy events: accessUser and accessGroup

  • Description: An audit event for an attribute applied to a group or user.

  • Additional parameter details: targetType will specify whether the attribute was added to a USER or GROUP.

AttributeRemoved event

  • Event: AttributeRemoved

  • Legacy events: accessUser and accessGroup

  • Description: An audit event for an attribute removed from a group or user.

  • Additional parameter details: targetType will specify whether the attribute was removed from a USER or GROUP.

ConfigurationUpdated event

  • Event: ConfigurationUpdated

  • Legacy event: configurationUpdate

  • Description: An audit event for updates to the configuration on the Immuta app settings page.

DatasourceAppliedToProject event

  • Event: DatasourceAppliedToProject

  • Legacy event: addToProject

  • Description: An audit event for adding a data source to an Immuta project.

DatasourceCatalogSynced event

  • Event: DatasourceCatalogSynced

  • Legacy event: catalogUpdate

  • Description: An audit event for syncing an external catalog to tag Immuta data sources.

DatasourceCreated event

  • Event: DatasourceCreated

  • Legacy event: dataSourceCreate

  • Description: An audit event for registering a table as an Immuta data source.

DatasourceDeleted event

  • Event: DatasourceDeleted

  • Legacy event: dataSourceDelete

  • Description: An audit event for deleting a data source in Immuta.

DatasourceDisabled event

  • Event: DatasourceDisabled

  • Legacy event: None

  • Description: An audit event for disabling a data source in Immuta.

DatasourceGlobalPolicyApplied event

  • Event: DatasourceGlobalPolicyApplied

  • Legacy event: globalPolicyApplied

  • Description: An audit event for applying a global policy to a data source.

DatasourceGlobalPolicyConflictResolved event

  • Event: DatasourceGlobalPolicyConflictResolved

  • Legacy event: globalPolicyConflictResolved

  • Description: An audit event for a global policy conflict being resolved on a data source.

DatasourceGlobalPolicyDisabled event

  • Event: DatasourceGlobalPolicyDisabled

  • Legacy event: globalPolicyDisabled

  • Description: An audit event for a data owner disabling a global policy from their data source.

DatasourceGlobalPolicyRemoved event

  • Event: DatasourceGlobalPolicyRemoved

  • Legacy event: globalPolicyRemoved

  • Description: An audit event for a data owner removing a global policy from their data source.

DatasourcePolicyCertificationExpired event

  • Event: DatasourcePolicyCertificationExpired

  • Legacy event: policyCertificationExpired

  • Description: An audit event for a global policy certification expiring on a data source.

DatasourcePolicyCertified event

  • Event: DatasourcePolicyCertified

  • Legacy event: globalPolicyCertify

  • Description: An audit event for a global policy being certified by a data owner for their data source.

DatasourcePolicyDecertified event

  • Event: DatasourcePolicyDecertified

  • Legacy events: None

  • Description: An audit event for a global policy being decertified on a data source.

DatasourceRemovedFromProject event

  • Event: DatasourceRemovedFromProject

  • Legacy event: removeFromProject

  • Description: An audit event for removing a data source from a project.

DatasourceUpdated event

  • Event: DatasourceUpdated

  • Legacy events: dataSourceUpdate and dataSourceSave

  • Description: An audit event for updating a data source with the new data source details.

DomainCreated event

  • Event: DomainCreated

  • Legacy event: collectionCreated

  • Description: An audit event for creating a domain.

DomainDataSourcesUpdated event

  • Event: DomainDataSourcesUpdated

  • Legacy events: collectionDataSourceAdded, collectionDataSourceRemoved, and collectionDataSourceUpdated

  • Description: An audit event for updating a domain's data sources.

  • Additional parameter details: auditPayload.updateType will specify whether the data source was added to or removed from the domain.

DomainDeleted event

  • Event: DomainDeleted

  • Legacy event: collectionDeleted

  • Description: An audit event for deleting a domain.

DomainPermissionsUpdated event

  • Event: DomainPermissionsUpdated

  • Legacy events: collectionPermissionGranted and collectionPermissionRevoked

  • Description: An audit event for granting or revoking a user's domain-related permissions.

  • Additional parameter details: auditPayload.updateType will specify whether the permission was granted to or revoked from a user.

DomainUpdated event

  • Event: DomainUpdated

  • Legacy event: collectionUpdated

  • Description: An audit event for updating an Immuta domain.

GlobalPolicyApprovalRescinded event

  • Event: GlobalPolicyApprovalRescinded

  • Legacy event: globalPolicyApprovalRescinded

  • Description: An audit event for a global policy approval rescinded in the approve to promote workflow.

GlobalPolicyApproved event

  • Event: GlobalPolicyApproved

  • Legacy event: globalPolicyApproved

  • Description: An audit event for a global policy approved in the approve to promote workflow.

GlobalPolicyChangeRequested event

  • Event: GlobalPolicyChangeRequested

  • Legacy event: globalPolicyChangeRequested

  • Description: An audit event for requested edits on a global policy in the approve to promote workflow.

GlobalPolicyCreated event

  • Event: GlobalPolicyCreated

  • Legacy event: globalPolicyCreate

  • Description: An audit event for creating a global policy.

GlobalPolicyDeleted event

  • Event: GlobalPolicyDeleted

  • Legacy event: globalPolicyDelete

  • Description: An audit event for deleting a global policy.

GlobalPolicyPromoted event

  • Event: GlobalPolicyPromoted

  • Legacy event: globalPolicyPromoted

  • Description: An audit event for when a global policy is fully approved and promoted to production in the approve to promote workflow.

GlobalPolicyReviewRequested event

  • Event: GlobalPolicyReviewRequested

  • Legacy event: globalPolicyReviewRequested

  • Description: An audit event for when a global policy is ready and requests a review in the approve to promote workflow.

GlobalPolicyUpdated event

  • Event: GlobalPolicyUpdated

  • Legacy event: globalPolicyUpdate

  • Description: An audit event for a global policy being updated with details about the policy.

GroupCreated event

  • Event: GroupCreated

  • Legacy event: accessGroup

  • Description: An audit event for a group created in Immuta.

GroupDeleted event

  • Event: GroupDeleted

  • Legacy event: accessGroup

  • Description: An audit event for a group deleted in Immuta.

GroupMemberAdded event

  • Event: GroupMemberAdded

  • Legacy event: accessGroup

  • Description: An audit event for a member added to a group in Immuta.

GroupMemberRemoved event

  • Event: GroupMemberRemoved

  • Legacy event: accessGroup

  • Description: An audit event for a group member removed from the group in Immuta.

GroupUpdated event

  • Event: GroupUpdated

  • Legacy event: accessGroup

  • Description: An audit event for a group updated in Immuta.

LicenseCreated event

  • Event: LicenseCreated

  • Legacy event: licenseCreate

  • Description: An audit event for creating an Immuta license.

LicenseDeleted event

  • Event: LicenseDeleted

  • Legacy event: licenseDelete

  • Description: An audit event for deleting an Immuta license.

LocalPolicyCreated event

  • Event: LocalPolicyCreated

  • Legacy event: policyHandlerCreate

  • Description: An audit event for creating a local policy for an Immuta data source.

LocalPolicyUpdated event

  • Event: LocalPolicyUpdated

  • Legacy event: policyHandlerUpdate

  • Description: An audit event for updating a local policy on an Immuta data source.

PermissionApplied event

  • Event: PermissionApplied

  • Legacy event: accessUser

  • Description: An audit event for a permission applied to an Immuta user.

PermissionRemoved event

  • Event: PermissionRemoved

  • Legacy event: accessUser

  • Description: An audit event for a permission removed from an Immuta user.

PolicyAdjustmentCreated event

  • Event: PolicyAdjustmentCreated

  • Legacy event: policyAdjustmentCreate

  • Description: An audit event for creating a policy adjustment in an Immuta project.

PolicyAdjustmentDeleted event

  • Event: PolicyAdjustmentDeleted

  • Legacy event: policyAdjustmentDelete

  • Description: An audit event for deleting a policy adjustment in an Immuta project.

ProjectCreated event

  • Event: ProjectCreated

  • Legacy event: projectCreate

  • Description: An audit event for creating a project in Immuta.

ProjectDeleted event

  • Event: ProjectDeleted

  • Legacy event: projectDelete

  • Description: An audit event for deleting a project in Immuta.

ProjectDisabled event

  • Event: ProjectDisabled

  • Legacy events: None

  • Description: An audit event for disabling a project in Immuta.

ProjectPurposeApproved event

  • Event: ProjectPurposeApproved

  • Legacy event: projectPurposeApprove

  • Description: An audit event for approving a purpose for a project in Immuta.

ProjectPurposeDenied event

  • Event: ProjectPurposeDenied

  • Legacy event: projectPurposeDeny

  • Description: An audit event for denying a purpose for a project in Immuta.

ProjectPurposesAcknowledged event

  • Event: ProjectPurposesAcknowledged

  • Legacy event: acknowledgePurposes

  • Description: An audit event for acknowledging a purpose for a project in Immuta.

ProjectUpdated event

  • Event: ProjectUpdated

  • Legacy event: projectPurposeDeny

  • Description: An audit event for updating a project in Immuta.

PurposeDeleted event

  • Event: PurposeDeleted

  • Legacy event: purposeDelete

  • Description: An audit event for deleting a purpose in Immuta.

PurposeUpdated event

  • Event: PurposeUpdated

  • Legacy event: purposeUpdate

  • Description: An audit event for updating a purpose in Immuta.

PurposeUpserted event

  • Event: PurposeUpserted

  • Legacy event: purposeCreate

  • Description: An audit event for creating a purpose in Immuta.

SDDClassifierCreated event

  • Event: SDDClassifierCreated

  • Legacy event: sddClassifierCreated

  • Description: An audit event for creating a sensitive data discovery (SDD) column name regex, regex, or dictionary pattern.

  • Additional parameter details:

    • auditPayload.config.columnNameRegex: For column name regex patterns, the regex to match against column names.

    • auditPayload.config.values: For dictionary patterns, the values within the dictionary pattern to match against column values.

    • auditPayload.config.regex: For regex patterns, the regex to match against column values.

SDDClassifierDeleted event

  • Event: SDDClassifierDeleted

  • Legacy event: sddClassifierDeleted

  • Description: An audit event for deleting a sensitive data discovery (SDD) pattern.

SDDClassifierUpdated event

  • Event: SDDClassifierUpdated

  • Legacy event: sddClassifierUpdated

  • Description: An audit event for updating a sensitive data discovery (SDD) column name regex, regex, or dictionary pattern.

  • Additional parameter details:

    • auditPayload.config.columnNameRegex: For column name regex patterns, the regex to match against column names.

    • auditPayload.config.values: For dictionary patterns, the values within the dictionary pattern to match against column values.

    • auditPayload.config.regex: For regex patterns, the regex to match against column values.

SDDDatasourceTagUpdated event

  • Event: SDDDatasourceTagUpdated

  • Legacy event: sddDatasourceTagUpdate

  • Description: An audit event for the results from a sensitive data discovery (SDD) run that updates the tags on Immuta data sources.

SDDTemplateApplied event

  • Event: SDDTemplateApplied

  • Legacy event: sddTemplateApplied

  • Description: An audit event for applying an identification framework to data sources.

SDDTemplateCloned event

  • Event: SDDTemplateCloned

  • Legacy event: sddTemplateCreated

  • Description: An audit event for cloning an identification framework from another framework.

SDDTemplateCreated event

  • Event: SDDTemplateCreated

  • Legacy event: sddTemplateCreated

  • Description: An audit event for creating an identification framework.

SDDTemplateDeleted event

  • Event: SDDTemplateDeleted

  • Legacy event: sddTemplateDeleted

  • Description: An audit event for deleting an identification framework.

SDDTemplateUpdated event

  • Event: SDDTemplateUpdated

  • Legacy event: sddTemplateUpdated

  • Description: An audit event for updating an identification framework.

SubscriptionCreated event

  • Event: SubscriptionCreated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for subscribing a user to a data source or project.

  • Additional parameter details: auditPayload.modelType will specify whether the user was subscribed to a DATASOURCE or PROJECT.

SubscriptionDeleted event

  • Event: SubscriptionUpdated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for removing a user's subscription to a data source or project.

  • Additional parameter details: auditPayload.modelType will specify whether the user's subscription was removed from a DATASOURCE or PROJECT.

SubscriptionRequestApproved event

  • Event: SubscriptionUpdated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for a user's request to subscribe to a data source or project.

  • Additional parameter details: targets.model.type will specify whether the subscription was approved for a DATASOURCE or PROJECT.

SubscriptionRequestDenied event

  • Event: SubscriptionUpdated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for denying a user's request to subscribe to a data source or project.

  • Additional parameter details: auditPayload.modelType will specify whether the user's subscription was denied for a DATASOURCE or PROJECT.

SubscriptionRequested event

  • Event: SubscriptionRequested

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for a user requesting to subscribe to a data source or project.

  • Additional parameter details: auditPayload.modelType will specify whether the user requested to subscribe to a DATASOURCE or PROJECT.

SubscriptionUpdated event

  • Event: SubscriptionUpdated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: An audit event for a user subscribing to a data source or project.

  • Additional parameter details: targets.model.type will specify whether the subscription was updated on a DATASOURCE or PROJECT.

TagApplied event

  • Event: TagApplied

  • Legacy event: tagAdded

  • Description: An audit event for applying a tag to an object in Immuta.

TagCreated event

  • Event: TagCreated

  • Legacy event: tagCreated

  • Description: An audit event for creating a tag in Immuta.

TagDeleted event

  • Event: TagDeleted

  • Legacy event: tagDeleted

  • Description: An audit event for deleting a tag in Immuta.

TagRemoved event

  • Event: TagRemoved

  • Legacy event: tagRemoved

  • Description: An audit event for removing a tag from an object in Immuta.

TagUpdated event

  • Event: TagUpdated

  • Legacy event: tagUpdated

  • Description: An audit event for updating a tag in Immuta.

UserAuthenticated event

  • Event: UserAuthenticated

  • Legacy event: authenticate

  • Description: An audit event for a user authenticating in Immuta.

  • Additional parameter details: authenticationMethod possible values include

    • OAuth: The user authenticated using the 3rd party authentication OAuth.

    • OpenId: The user authenticated using the 3rd party authentication OpenId.

    • SAML: The user authenticated using the 3rd party authentication SAML.

    • apiKey: The user authenticated or impersonated using an API key.

    • password: The user authenticated with username and password.

UserCloned event

  • Event: UserCloned

  • Legacy event: accessUser

  • Description: An audit event for creating a new user in Immuta by cloning an existing user.

UserCreated event

  • Event: UserCreated

  • Legacy event: accessUser

  • Description: An audit event for creating a new user in Immuta.

UserDeleted event

  • Event: UserDeleted

  • Legacy event: accessUser

  • Description: An audit event for deleting a user in Immuta.

UserLogout event

  • Event: UserLogout

  • Legacy events: None

  • Description: An audit event for a user logging out of Immuta.

  • Additional parameter details:

    • authenticationMethod possible values include

      • OAuth: The user authenticated using the 3rd party authentication OAuth.

      • OpenId: The user authenticated using the 3rd party authentication OpenId.

      • SAML: The user authenticated using the 3rd party authentication SAML.

      • apiKey: The user authenticated or impersonated using an API key.

      • password: The user authenticated with username and password.

    • logoutReason possible values include

      • EXPIRATION: The user was logged out because the token expired.

      • IDP_INITIATED: The IdP initiated the logout.

      • USER_LOGOUT_TRIGGERED: The user manually logged out.

UserOneTimeTokenCreated event

  • Event: UserOneTimeTokenCreated

  • Legacy event: accessUser

  • Description: An audit event for creating a single use login token for a user.

UserPasswordUpdated event

  • Event: UserPasswordUpdated

  • Legacy event: accessUser

  • Description: An audit event for updating a user's Immuta password.

UserUpdated event

  • Event: UserUpdated

  • Legacy event: externalUserIdChanged

  • Description: An audit event for updating user details in Immuta.

WebhookCreated event

  • Event: WebhookCreated

  • Legacy event: webhookCreate

  • Description: An audit event for creating an Immuta webhook.

WebhookDeleted event

  • Event: WebhookDeleted

  • Legacy event: webhookDelete

  • Description: An audit event for deleting an Immuta webhook.

Last updated

Was this helpful?