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

API keys

  • ApiKeyCreated: An API key is created on the Immuta app settings page or from an Immuta user's profile page.

  • ApiKeyDeleted: An API key is deleted.

Attributes

Configuration

ConfigurationUpdated: The Immuta configuration on the app settings page is updated.

Data sources

Domains

Global policies

Groups

  • GroupCreated: A group is created in Immuta by user actions in the UI or ingested from an external IAM.

  • GroupDeleted: A group is deleted in Immuta by user actions in the UI or from within an external IAM.

  • GroupMemberAdded: A user is added to a group in Immuta by user actions in the UI or from within an external IAM.

  • GroupMemberRemoved: A user is removed from a group in Immuta by user actions in the UI or from within an external IAM.

  • GroupUpdated: A group's details (email, name, description, etc.) are updated.

Identification

License

Local policies

Permissions

Projects

Purposes

Queries

Subscriptions

Tags

Users

Webhooks

ApiKeyCreated event

  • Event: ApiKeyCreated

  • Legacy event: apiKey

  • Description: 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 API key is deleted.

AttributeApplied event

  • Event: AttributeApplied

  • Legacy events: accessUser and accessGroup

  • Description: An attribute is applied to a user or group.

  • 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 attribute is removed from a user or group.

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

ConfigurationUpdated event

  • Event: ConfigurationUpdated

  • Legacy event: configurationUpdate

  • Description: The Immuta configuration on the app settings page is updated.

DatasourceAppliedToProject event

  • Event: DatasourceAppliedToProject

  • Legacy event: addToProject

  • Description: A data source is added to a project.

DatasourceCatalogSynced event

  • Event: DatasourceCatalogSynced

  • Legacy event: catalogUpdate

  • Description: An external catalog and its tags are synced on a data source.

DatasourceCreated event

  • Event: DatasourceCreated

  • Legacy event: dataSourceCreate

  • Description: A data source is created.

DatasourceDeleted event

  • Event: DatasourceDeleted

  • Legacy event: dataSourceDelete

  • Description: A data source is deleted.

DatasourceDisabled event

  • Event: DatasourceDisabled

  • Legacy event: None

  • Description: A data source is disabled.

DatasourceGlobalPolicyApplied event

  • Event: DatasourceGlobalPolicyApplied

  • Legacy event: globalPolicyApplied

  • Description: A global policy is applied to a data source.

DatasourceGlobalPolicyConflictResolved event

  • Event: DatasourceGlobalPolicyConflictResolved

  • Legacy event: globalPolicyConflictResolved

  • Description: A policy conflict between two global policies on a data source is resolved.

DatasourceGlobalPolicyDisabled event

  • Event: DatasourceGlobalPolicyDisabled

  • Legacy event: globalPolicyDisabled

  • Description: A global policy is disabled on a data source.

DatasourceGlobalPolicyRemoved event

  • Event: DatasourceGlobalPolicyRemoved

  • Legacy event: globalPolicyRemoved

  • Description: A global policy is removed from a data source.

DatasourcePolicyCertificationExpired event

  • Event: DatasourcePolicyCertificationExpired

  • Legacy event: policyCertificationExpired

  • Description: The global policy certification on a data source is expired.

DatasourcePolicyCertified event

  • Event: DatasourcePolicyCertified

  • Legacy event: globalPolicyCertify

  • Description: A global policy is certified for a data source.

DatasourcePolicyDecertified event

  • Event: DatasourcePolicyDecertified

  • Legacy events: None

  • Description: A global policy is decertified for a data source.

DatasourceRemovedFromProject event

  • Event: DatasourceRemovedFromProject

  • Legacy event: removeFromProject

  • Description: A data source is removed from a project.

DatasourceUpdated event

  • Event: DatasourceUpdated

  • Legacy events: dataSourceUpdate and dataSourceSave

  • Description: A data source is updated.

DomainCreated event

  • Event: DomainCreated

  • Legacy event: collectionCreated

  • Description: A domain is created.

DomainDataSourcesUpdated event

  • Event: DomainDataSourcesUpdated

  • Legacy events: collectionDataSourceAdded, collectionDataSourceRemoved, and collectionDataSourceUpdated

  • Description: Data sources are assigned to or removed from the domain.

  • 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: A domain is deleted.

DomainPermissionsUpdated event

  • Event: DomainPermissionsUpdated

  • Legacy events: collectionPermissionGranted and collectionPermissionRevoked

  • Description: A domain-specific permission is applied to or removed from a user or group.

  • 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: A domain's details (name, description, settings etc.) are updated.

GlobalPolicyApprovalRescinded event

  • Event: GlobalPolicyApprovalRescinded

  • Legacy event: globalPolicyApprovalRescinded

  • Description: The approval for a global policy is rescinded with the approve to promote feature (private preview).

GlobalPolicyApproved event

  • Event: GlobalPolicyApproved

  • Legacy event: globalPolicyApproved

  • Description: A global policy is approved with the approve to promote feature (private preview).

GlobalPolicyChangeRequested event

  • Event: GlobalPolicyChangeRequested

  • Legacy event: globalPolicyChangeRequested

  • Description: A change to a global policy is requested with the approve to promote feature (private preview).

GlobalPolicyCreated event

  • Event: GlobalPolicyCreated

  • Legacy event: globalPolicyCreate

  • Description: A global policy is created.

GlobalPolicyDeleted event

  • Event: GlobalPolicyDeleted

  • Legacy event: globalPolicyDelete

  • Description: A global policy is deleted.

GlobalPolicyPromoted event

  • Event: GlobalPolicyPromoted

  • Legacy event: globalPolicyPromoted

  • Description: A global policy is promoted to production with the approve to promote feature (private preview).

GlobalPolicyReviewRequested event

  • Event: GlobalPolicyReviewRequested

  • Legacy event: globalPolicyReviewRequested

  • Description: A review is requested for a global policy with the approve to promote feature (private preview).

GlobalPolicyUpdated event

  • Event: GlobalPolicyUpdated

  • Legacy event: globalPolicyUpdate

  • Description: A global policy is updated.

GroupCreated event

  • Event: GroupCreated

  • Legacy event: accessGroup

  • Description: A group is created in Immuta by user actions in the UI or ingested from an external IAM.

GroupDeleted event

  • Event: GroupDeleted

  • Legacy event: accessGroup

  • Description: A group is deleted in Immuta by user actions in the UI or from within an external IAM.

GroupMemberAdded event

  • Event: GroupMemberAdded

  • Legacy event: accessGroup

  • Description: A user is added to a group in Immuta by user actions in the UI or from within an external IAM.

GroupMemberRemoved event

  • Event: GroupMemberRemoved

  • Legacy event: accessGroup

  • Description: A user is removed from a group in Immuta by user actions in the UI or from within an external IAM.

GroupUpdated event

  • Event: GroupUpdated

  • Legacy event: accessGroup

  • Description: A group's details (email, name, description, etc.) are updated.

LicenseCreated event

  • Event: LicenseCreated

  • Legacy event: licenseCreate

  • Description: An Immuta license is created.

LicenseDeleted event

  • Event: LicenseDeleted

  • Legacy event: licenseDelete

  • Description: An Immuta license is deleted.

LocalPolicyCreated event

  • Event: LocalPolicyCreated

  • Legacy event: policyHandlerCreate

  • Description: A local policy is created on a data source.

LocalPolicyUpdated event

  • Event: LocalPolicyUpdated

  • Legacy event: policyHandlerUpdate

  • Description: A local policy is updated on a data source.

PermissionApplied event

  • Event: PermissionApplied

  • Legacy event: accessUser

  • Description: A global permission is applied to a user.

PermissionRemoved event

  • Event: PermissionRemoved

  • Legacy event: accessUser

  • Description: A global permission is removed from a user.

ProjectCreated event

  • Event: ProjectCreated

  • Legacy event: projectCreate

  • Description: A project is created.

ProjectDeleted event

  • Event: ProjectDeleted

  • Legacy event: projectDelete

  • Description: A project is deleted.

ProjectDisabled event

  • Event: ProjectDisabled

  • Legacy events: None

  • Description: A project is disabled.

ProjectPurposeApproved event

  • Event: ProjectPurposeApproved

  • Legacy event: projectPurposeApprove

  • Description: A purpose is approved within a project.

ProjectPurposeDenied event

  • Event: ProjectPurposeDenied

  • Legacy event: projectPurposeDeny

  • Description: A purpose is denied within a project.

ProjectPurposesAcknowledged event

  • Event: ProjectPurposesAcknowledged

  • Legacy event: acknowledgePurposes

  • Description: A user acknowledged a purpose within a project.

ProjectUpdated event

  • Event: ProjectUpdated

  • Legacy event: projectPurposeDeny

  • Description: A project is updated.

PurposeDeleted event

  • Event: PurposeDeleted

  • Legacy event: purposeDelete

  • Description: A purpose is deleted.

PurposeUpdated event

  • Event: PurposeUpdated

  • Legacy event: purposeUpdate

  • Description: A purpose is updated.

PurposeUpserted event

  • Event: PurposeUpserted

  • Legacy event: purposeCreate

  • Description: A purpose is created.

SDDClassifierCreated event

  • Event: SDDClassifierCreated

  • Legacy event: sddClassifierCreated

  • Description: An identifier is created.

  • Additional parameter details:

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

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

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

SDDClassifierDeleted event

  • Event: SDDClassifierDeleted

  • Legacy event: sddClassifierDeleted

  • Description: An identifier is deleted.

SDDClassifierUpdated event

  • Event: SDDClassifierUpdated

  • Legacy event: sddClassifierUpdated

  • Description: An identifier is updated.

  • Additional parameter details:

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

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

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

SubscriptionCreated event

  • Event: SubscriptionCreated

  • Legacy events: dataSourceSubscription and projectSubscription

  • Description: A user is subscribed 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: A user's subscription to a data source or project is removed.

  • 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: A user's request to subscribe to a data source or project is approved.

  • 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: A user's request to subscribe to a data source or project is denied.

  • 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: A user requests 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: A user's subscription to a data source or project is updated.

  • 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: A tag is applied to a data source or column.

TagCreated event

  • Event: TagCreated

  • Legacy event: tagCreated

  • Description: A tag is created.

TagDeleted event

  • Event: TagDeleted

  • Legacy event: tagDeleted

  • Description: A tag is deleted.

TagRemoved event

  • Event: TagRemoved

  • Legacy event: tagRemoved

  • Description: A tag is removed from a data source or column.

TagUpdated event

  • Event: TagUpdated

  • Legacy event: tagUpdated

  • Description: A tag is updated.

UserAuthenticated event

  • Event: UserAuthenticated

  • Legacy event: authenticate

  • Description: A user signs in to 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. The user is running API calls and did not sign in to the UI.

    • password: The user authenticated with username and password.

UserCloned event

  • Event: UserCloned

  • Legacy event: accessUser

  • Description: A user is cloned.

UserCreated event

  • Event: UserCreated

  • Legacy event: accessUser

  • Description: A user is created.

UserDeleted event

  • Event: UserDeleted

  • Legacy event: accessUser

  • Description: A user is deleted.

UserLogout event

  • Event: UserLogout

  • Legacy events: None

  • Description: A user logs 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: A sign-in token is created for a user.

UserPasswordUpdated event

  • Event: UserPasswordUpdated

  • Legacy event: accessUser

  • Description: A user's password is updated.

UserUpdated event

  • Event: UserUpdated

  • Legacy event: externalUserIdChanged

  • Description: A user's details are updated.

WebhookCreated event

  • Event: WebhookCreated

  • Legacy event: webhookCreate

  • Description: A webhook is created.

WebhookDeleted event

  • Event: WebhookDeleted

  • Legacy event: webhookDelete

  • Description: A webhook is deleted.

Last updated

Was this helpful?