Immuta Audit GraphQL API Reference Documentation

This Immuta Audit GraphQL API reference includes the complete set of GraphQL queries, mutations, types, and their parameters for exporting and storing audit logs and querying audit and export job configurations. For tutorials using this API, see the Audit Log Export guide.

API Endpoints
# Production:
https://example.immutacloud.com/api/audit/graphql

Queries

getAllExportConfigurations

Description

Get all export configurations.

Response

Returns [ExportConfiguration!]!

Example

Query
query getAllExportConfigurations {
  getAllExportConfigurations {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Response
{
  "data": {
    "getAllExportConfigurations": [
      {
        "id": "4",
        "interval": "EVERY_2_HOURS",
        "enabled": true,
        "endpointConfiguration": S3EndpointConfiguration,
        "createdBy": User,
        "createdAt": "2007-12-03T10:15:30Z",
        "updatedBy": User,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getAllExportJobTasks

Description

Get all export job tasks by export job ID.

Response

Returns [ExportJobTask!]!

Arguments
Name Description
exportJobId - String! The export job ID.

Example

Query
query getAllExportJobTasks($exportJobId: String!) {
  getAllExportJobTasks(exportJobId: $exportJobId) {
    id
    startTimestamp
    endTimestamp
    attempts
    offset
    limit
    status
    failureReason
  }
}
Variables
{"exportJobId": "xyz789"}
Response
{
  "data": {
    "getAllExportJobTasks": [
      {
        "id": "4",
        "startTimestamp": "2007-12-03T10:15:30Z",
        "endTimestamp": "2007-12-03T10:15:30Z",
        "attempts": 123.45,
        "offset": 987,
        "limit": 987,
        "status": "RUNNING",
        "failureReason": "xyz789"
      }
    ]
  }
}

getAllExportJobs

Description

Get all export jobs.

Response

Returns [ExportJob!]!

Example

Query
query getAllExportJobs {
  getAllExportJobs {
    id
    exportConfiguration {
      ...ExportConfigurationFragment
    }
    startTimestamp
    endTimestamp
    status
    tasks {
      ...ExportJobTaskFragment
    }
    windowStart
    windowEnd
    failureReason
  }
}
Response
{
  "data": {
    "getAllExportJobs": [
      {
        "id": "4",
        "exportConfiguration": ExportConfiguration,
        "startTimestamp": "2007-12-03T10:15:30Z",
        "endTimestamp": "2007-12-03T10:15:30Z",
        "status": "RUNNING",
        "tasks": [ExportJobTask],
        "windowStart": "2007-12-03T10:15:30Z",
        "windowEnd": "2007-12-03T10:15:30Z",
        "failureReason": "abc123"
      }
    ]
  }
}

getAttributeAppliedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getAttributeAppliedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getAttributeAppliedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...AttributeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getAttributeAppliedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": AttributeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getAttributeRemovedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getAttributeRemovedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getAttributeRemovedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...AttributeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getAttributeRemovedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": AttributeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatabricksQueryAuditEvents

Response

Returns [QueryAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatabricksQueryAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatabricksQueryAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...QueryAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatabricksQueryAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": QueryAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatasourceCatalogSyncedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatasourceCatalogSyncedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatasourceCatalogSyncedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatasourceCatalogSyncedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatasourceCreatedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatasourceCreatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatasourceCreatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatasourceCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatasourceDeletedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatasourceDeletedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatasourceDeletedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatasourceDeletedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatasourceDisabledAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatasourceDisabledAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatasourceDisabledAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatasourceDisabledAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getDatasourceUpdatedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getDatasourceUpdatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getDatasourceUpdatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getDatasourceUpdatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getExportConfigurationById

Description

Gets an export configuration by its id

Response

Returns an ExportConfiguration!

Arguments
Name Description
id - String! The ID of the export configuration.

Example

Query
query getExportConfigurationById($id: String!) {
  getExportConfigurationById(id: $id) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "getExportConfigurationById": {
      "id": "4",
      "interval": "EVERY_2_HOURS",
      "enabled": false,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

getExportJobById

Description

Get export job by ID.

Response

Returns an ExportJob!

Arguments
Name Description
id - String! The export job ID.

Example

Query
query getExportJobById($id: String!) {
  getExportJobById(id: $id) {
    id
    exportConfiguration {
      ...ExportConfigurationFragment
    }
    startTimestamp
    endTimestamp
    status
    tasks {
      ...ExportJobTaskFragment
    }
    windowStart
    windowEnd
    failureReason
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "getExportJobById": {
      "id": "4",
      "exportConfiguration": ExportConfiguration,
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "status": "RUNNING",
      "tasks": [ExportJobTask],
      "windowStart": "2007-12-03T10:15:30Z",
      "windowEnd": "2007-12-03T10:15:30Z",
      "failureReason": "xyz789"
    }
  }
}

getExportJobTaskById

Description

Get export job task by ID.

Response

Returns an ExportJobTask!

Arguments
Name Description
id - String! The export job task ID.

Example

Query
query getExportJobTaskById($id: String!) {
  getExportJobTaskById(id: $id) {
    id
    startTimestamp
    endTimestamp
    attempts
    offset
    limit
    status
    failureReason
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "getExportJobTaskById": {
      "id": "4",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "attempts": 123.45,
      "offset": 987,
      "limit": 123,
      "status": "RUNNING",
      "failureReason": "abc123"
    }
  }
}

getLicenseCreatedAuditEvents

Response

Returns [LicenseCreatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getLicenseCreatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getLicenseCreatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...LicenseFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...LicenseAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getLicenseCreatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [License],
        "relatedResources": [Resource],
        "auditPayload": LicenseAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getLicenseDeletedAuditEvents

Response

Returns [LicenseDeletedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getLicenseDeletedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getLicenseDeletedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...LicenseFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...LicenseAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getLicenseDeletedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [License],
        "relatedResources": [Resource],
        "auditPayload": LicenseAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getPurposeDeletedAuditEvents

Response

Returns [PurposeDeletedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getPurposeDeletedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getPurposeDeletedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getPurposeDeletedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getPurposeUpdatedAuditEvents

Response

Returns [PurposeUpdatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getPurposeUpdatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getPurposeUpdatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getPurposeUpdatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getPurposeUpsertedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getPurposeUpsertedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getPurposeUpsertedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getPurposeUpsertedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getSnowflakeQueryAuditEvents

Response

Returns [QueryAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getSnowflakeQueryAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getSnowflakeQueryAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...QueryAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getSnowflakeQueryAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": QueryAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getTagAppliedAuditEvents

Response

Returns [TagAppliedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getTagAppliedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getTagAppliedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getTagAppliedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getTagCreatedAuditEvents

Response

Returns [TagCreatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getTagCreatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getTagCreatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getTagCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getTagDeletedAuditEvents

Response

Returns [TagDeletedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getTagDeletedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getTagDeletedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getTagDeletedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getTagRemovedAuditEvents

Response

Returns [TagRemovedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getTagRemovedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getTagRemovedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getTagRemovedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getTagUpdatedAuditEvents

Response

Returns [TagUpdatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getTagUpdatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getTagUpdatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getTagUpdatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getUserAuthenticatedAuditEvents

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getUserAuthenticatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getUserAuthenticatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...UserFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...UserAuthenticatedAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getUserAuthenticatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [User],
        "relatedResources": [Resource],
        "auditPayload": UserAuthenticatedAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getUserUpdatedAuditEvents

Response

Returns [UserUpdatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getUserUpdatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getUserUpdatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...UserFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...UserAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getUserUpdatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [User],
        "relatedResources": [Resource],
        "auditPayload": UserAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getWebhookCreatedAuditEvents

Response

Returns [WebhookCreatedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getWebhookCreatedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getWebhookCreatedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...WebhookFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...WebhookAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getWebhookCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Webhook],
        "relatedResources": [Resource],
        "auditPayload": WebhookAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getWebhookDeletedAuditEvents

Response

Returns [WebhookDeletedAuditEvent!]!

Arguments
Name Description
criteria - AuditEventSearchCriteriaInput The search criteria

Example

Query
query getWebhookDeletedAuditEvents($criteria: AuditEventSearchCriteriaInput) {
  getWebhookDeletedAuditEvents(criteria: $criteria) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...WebhookFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...WebhookAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"criteria": AuditEventSearchCriteriaInput}
Response
{
  "data": {
    "getWebhookDeletedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Webhook],
        "relatedResources": [Resource],
        "auditPayload": WebhookAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Mutations

addAttributeAppliedAuditEvents

Description

Handles storing attribute applied audit events.

Arguments
Name Description
data - [AttributeAppliedAuditEventInput!]!

Example

Query
mutation addAttributeAppliedAuditEvents($data: [AttributeAppliedAuditEventInput!]!) {
  addAttributeAppliedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...AttributeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [AttributeAppliedAuditEventInput]}
Response
{
  "data": {
    "addAttributeAppliedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": AttributeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addAttributeRemovedAuditEvents

Description

Handles storing attribute removed audit events.

Arguments
Name Description
data - [AttributeRemovedAuditEventInput!]!

Example

Query
mutation addAttributeRemovedAuditEvents($data: [AttributeRemovedAuditEventInput!]!) {
  addAttributeRemovedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...AttributeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [AttributeRemovedAuditEventInput]}
Response
{
  "data": {
    "addAttributeRemovedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": AttributeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatabricksQueryAuditEvents

Description

Handles storing query audit events originating from Databricks.

Response

Returns [QueryAuditEvent!]!

Arguments
Name Description
data - [DatabricksQueryAuditEventInput!]!

Example

Query
mutation addDatabricksQueryAuditEvents($data: [DatabricksQueryAuditEventInput!]!) {
  addDatabricksQueryAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...QueryAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatabricksQueryAuditEventInput]}
Response
{
  "data": {
    "addDatabricksQueryAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": QueryAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatasourceCatalogSyncedAuditEvents

Description

Handles storing data source deleted audit events.

Arguments
Name Description
data - [DatasourceCatalogSyncedAuditEventInput!]!

Example

Query
mutation addDatasourceCatalogSyncedAuditEvents($data: [DatasourceCatalogSyncedAuditEventInput!]!) {
  addDatasourceCatalogSyncedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatasourceCatalogSyncedAuditEventInput]}
Response
{
  "data": {
    "addDatasourceCatalogSyncedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatasourceCreatedAuditEvents

Description

Handles storing data source created audit events.

Arguments
Name Description
data - [DatasourceCreatedAuditEventInput!]!

Example

Query
mutation addDatasourceCreatedAuditEvents($data: [DatasourceCreatedAuditEventInput!]!) {
  addDatasourceCreatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatasourceCreatedAuditEventInput]}
Response
{
  "data": {
    "addDatasourceCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatasourceDeletedAuditEvents

Description

Handles storing data source deleted audit events.

Arguments
Name Description
data - [DatasourceDeletedAuditEventInput!]!

Example

Query
mutation addDatasourceDeletedAuditEvents($data: [DatasourceDeletedAuditEventInput!]!) {
  addDatasourceDeletedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatasourceDeletedAuditEventInput]}
Response
{
  "data": {
    "addDatasourceDeletedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatasourceDisabledAuditEvents

Description

Handles storing data source disabled audit events.

Arguments
Name Description
data - [DatasourceDisabledAuditEventInput!]!

Example

Query
mutation addDatasourceDisabledAuditEvents($data: [DatasourceDisabledAuditEventInput!]!) {
  addDatasourceDisabledAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatasourceDisabledAuditEventInput]}
Response
{
  "data": {
    "addDatasourceDisabledAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addDatasourceUpdatedAuditEvents

Description

Handles storing data source updated audit events.

Arguments
Name Description
data - [DatasourceUpdatedAuditEventInput!]!

Example

Query
mutation addDatasourceUpdatedAuditEvents($data: [DatasourceUpdatedAuditEventInput!]!) {
  addDatasourceUpdatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...DatasourceAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [DatasourceUpdatedAuditEventInput]}
Response
{
  "data": {
    "addDatasourceUpdatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": DatasourceAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addLicenseCreatedAuditEvents

Description

Handles storing license created audit events.

Response

Returns [LicenseCreatedAuditEvent!]!

Arguments
Name Description
data - [LicenseCreatedAuditEventInput!]!

Example

Query
mutation addLicenseCreatedAuditEvents($data: [LicenseCreatedAuditEventInput!]!) {
  addLicenseCreatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...LicenseFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...LicenseAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [LicenseCreatedAuditEventInput]}
Response
{
  "data": {
    "addLicenseCreatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [License],
        "relatedResources": [Resource],
        "auditPayload": LicenseAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addLicenseDeletedAuditEvents

Description

Handles storing license deleted audit events.

Response

Returns [LicenseDeletedAuditEvent!]!

Arguments
Name Description
data - [LicenseDeletedAuditEventInput!]!

Example

Query
mutation addLicenseDeletedAuditEvents($data: [LicenseDeletedAuditEventInput!]!) {
  addLicenseDeletedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...LicenseFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...LicenseAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [LicenseDeletedAuditEventInput]}
Response
{
  "data": {
    "addLicenseDeletedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [License],
        "relatedResources": [Resource],
        "auditPayload": LicenseAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addPurposeDeletedAuditEvents

Description

Handles storing purpose deleted audit events.

Response

Returns [PurposeDeletedAuditEvent!]!

Arguments
Name Description
data - [PurposeDeletedAuditEventInput!]!

Example

Query
mutation addPurposeDeletedAuditEvents($data: [PurposeDeletedAuditEventInput!]!) {
  addPurposeDeletedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [PurposeDeletedAuditEventInput]}
Response
{
  "data": {
    "addPurposeDeletedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addPurposeUpdatedAuditEvents

Description

Handles storing purpose updated audit events.

Response

Returns [PurposeUpdatedAuditEvent!]!

Arguments
Name Description
data - [PurposeUpdatedAuditEventInput!]!

Example

Query
mutation addPurposeUpdatedAuditEvents($data: [PurposeUpdatedAuditEventInput!]!) {
  addPurposeUpdatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [PurposeUpdatedAuditEventInput]}
Response
{
  "data": {
    "addPurposeUpdatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addPurposeUpsertedAuditEvents

Description

Handles storing purpose upserted audit events.

Arguments
Name Description
data - [PurposeUpsertedAuditEventInput!]!

Example

Query
mutation addPurposeUpsertedAuditEvents($data: [PurposeUpsertedAuditEventInput!]!) {
  addPurposeUpsertedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...PurposeFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...PurposeAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [PurposeUpsertedAuditEventInput]}
Response
{
  "data": {
    "addPurposeUpsertedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Purpose],
        "relatedResources": [Resource],
        "auditPayload": PurposeAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addSnowflakeQueryAuditEvents

Description

Handles storing query audit events originating from Snowflake.

Response

Returns [QueryAuditEvent!]!

Arguments
Name Description
data - [SnowflakeQueryAuditEventInput!]!

Example

Query
mutation addSnowflakeQueryAuditEvents($data: [SnowflakeQueryAuditEventInput!]!) {
  addSnowflakeQueryAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...DatasourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...QueryAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [SnowflakeQueryAuditEventInput]}
Response
{
  "data": {
    "addSnowflakeQueryAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Datasource],
        "relatedResources": [Resource],
        "auditPayload": QueryAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addTagAppliedAuditEvents

Description

Handles storing tag applied audit events.

Response

Returns [TagAppliedAuditEvent!]!

Arguments
Name Description
data - [TagAppliedAuditEventInput!]!

Example

Query
mutation addTagAppliedAuditEvents($data: [TagAppliedAuditEventInput!]!) {
  addTagAppliedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [TagAppliedAuditEventInput]}
Response
{
  "data": {
    "addTagAppliedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addTagCreatedAuditEvents

Description

Handles storing tag created audit events.

Response

Returns [TagCreatedAuditEvent!]!

Arguments
Name Description
data - [TagCreatedAuditEventInput!]!

Example

Query
mutation addTagCreatedAuditEvents($data: [TagCreatedAuditEventInput!]!) {
  addTagCreatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [TagCreatedAuditEventInput]}
Response
{
  "data": {
    "addTagCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "abc123",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "abc123",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addTagDeletedAuditEvents

Description

Handles storing tag deleted audit events.

Response

Returns [TagDeletedAuditEvent!]!

Arguments
Name Description
data - [TagDeletedAuditEventInput!]!

Example

Query
mutation addTagDeletedAuditEvents($data: [TagDeletedAuditEventInput!]!) {
  addTagDeletedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [TagDeletedAuditEventInput]}
Response
{
  "data": {
    "addTagDeletedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addTagRemovedAuditEvents

Description

Handles storing tag removed audit events.

Response

Returns [TagRemovedAuditEvent!]!

Arguments
Name Description
data - [TagRemovedAuditEventInput!]!

Example

Query
mutation addTagRemovedAuditEvents($data: [TagRemovedAuditEventInput!]!) {
  addTagRemovedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [TagRemovedAuditEventInput]}
Response
{
  "data": {
    "addTagRemovedAuditEvents": [
      {
        "id": "4",
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addTagUpdatedAuditEvents

Description

Handles storing tag updated audit events.

Response

Returns [TagUpdatedAuditEvent!]!

Arguments
Name Description
data - [TagUpdatedAuditEventInput!]!

Example

Query
mutation addTagUpdatedAuditEvents($data: [TagUpdatedAuditEventInput!]!) {
  addTagUpdatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...ResourceFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...TagAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [TagUpdatedAuditEventInput]}
Response
{
  "data": {
    "addTagUpdatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "abc123",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Resource],
        "relatedResources": [Resource],
        "auditPayload": TagAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addUserAuthenticatedAuditEvents

Description

Handles storing user authenticated audit events.

Arguments
Name Description
data - [UserAuthenticatedAuditEventInput!]!

Example

Query
mutation addUserAuthenticatedAuditEvents($data: [UserAuthenticatedAuditEventInput!]!) {
  addUserAuthenticatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...UserFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...UserAuthenticatedAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [UserAuthenticatedAuditEventInput]}
Response
{
  "data": {
    "addUserAuthenticatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "abc123",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [User],
        "relatedResources": [Resource],
        "auditPayload": UserAuthenticatedAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addUserUpdatedAuditEvents

Description

Handles storing user updated audit events.

Response

Returns [UserUpdatedAuditEvent!]!

Arguments
Name Description
data - [UserUpdatedAuditEventInput!]!

Example

Query
mutation addUserUpdatedAuditEvents($data: [UserUpdatedAuditEventInput!]!) {
  addUserUpdatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...UserFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...UserAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [UserUpdatedAuditEventInput]}
Response
{
  "data": {
    "addUserUpdatedAuditEvents": [
      {
        "id": 4,
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [User],
        "relatedResources": [Resource],
        "auditPayload": UserAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addWebhookCreatedAuditEvents

Description

Handles storing webhook created audit events.

Response

Returns [WebhookCreatedAuditEvent!]!

Arguments
Name Description
data - [WebhookCreatedAuditEventInput!]!

Example

Query
mutation addWebhookCreatedAuditEvents($data: [WebhookCreatedAuditEventInput!]!) {
  addWebhookCreatedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...WebhookFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...WebhookAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [WebhookCreatedAuditEventInput]}
Response
{
  "data": {
    "addWebhookCreatedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "abc123",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "xyz789",
        "actor": UserActor,
        "actorIp": "xyz789",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Webhook],
        "relatedResources": [Resource],
        "auditPayload": WebhookAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

addWebhookDeletedAuditEvents

Description

Handles storing webhook deleted audit events.

Response

Returns [WebhookDeletedAuditEvent!]!

Arguments
Name Description
data - [WebhookDeletedAuditEventInput!]!

Example

Query
mutation addWebhookDeletedAuditEvents($data: [WebhookDeletedAuditEventInput!]!) {
  addWebhookDeletedAuditEvents(data: $data) {
    id
    sessionId
    userAgent
    requestId
    action
    actionStatus
    actionStatusReason
    actor {
      ... on UserActor {
        ...UserActorFragment
      }
      ... on SystemAccount {
        ...SystemAccountFragment
      }
      ... on UnknownUser {
        ...UnknownUserFragment
      }
    }
    actorIp
    tenantId
    targetType
    targets {
      ...WebhookFragment
    }
    relatedResources {
      ...ResourceFragment
    }
    auditPayload {
      ...WebhookAuditPayloadFragment
    }
    eventTimestamp
    receivedTimestamp
  }
}
Variables
{"data": [WebhookDeletedAuditEventInput]}
Response
{
  "data": {
    "addWebhookDeletedAuditEvents": [
      {
        "id": "4",
        "sessionId": "xyz789",
        "userAgent": "xyz789",
        "requestId": "xyz789",
        "action": "ATTRIBUTE_APPLY",
        "actionStatus": "SUCCESS",
        "actionStatusReason": "abc123",
        "actor": UserActor,
        "actorIp": "abc123",
        "tenantId": "xyz789",
        "targetType": "ATTRIBUTE",
        "targets": [Webhook],
        "relatedResources": [Resource],
        "auditPayload": WebhookAuditPayload,
        "eventTimestamp": "2007-12-03T10:15:30Z",
        "receivedTimestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

createExportJob

Description

Creates an export job.

Response

Returns an ExportJob!

Arguments
Name Description
exportConfigurationId - String! The export configuration for this job.

Example

Query
mutation createExportJob($exportConfigurationId: String!) {
  createExportJob(exportConfigurationId: $exportConfigurationId) {
    id
    exportConfiguration {
      ...ExportConfigurationFragment
    }
    startTimestamp
    endTimestamp
    status
    tasks {
      ...ExportJobTaskFragment
    }
    windowStart
    windowEnd
    failureReason
  }
}
Variables
{"exportConfigurationId": "abc123"}
Response
{
  "data": {
    "createExportJob": {
      "id": 4,
      "exportConfiguration": ExportConfiguration,
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "status": "RUNNING",
      "tasks": [ExportJobTask],
      "windowStart": "2007-12-03T10:15:30Z",
      "windowEnd": "2007-12-03T10:15:30Z",
      "failureReason": "xyz789"
    }
  }
}

createExportJobTask

Description

Creates an export job task.

Response

Returns an ExportJobTask!

Arguments
Name Description
data - CreateExportJobTaskInput! The export job task

Example

Query
mutation createExportJobTask($data: CreateExportJobTaskInput!) {
  createExportJobTask(data: $data) {
    id
    startTimestamp
    endTimestamp
    attempts
    offset
    limit
    status
    failureReason
  }
}
Variables
{"data": CreateExportJobTaskInput}
Response
{
  "data": {
    "createExportJobTask": {
      "id": 4,
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "attempts": 987.65,
      "offset": 987,
      "limit": 987,
      "status": "RUNNING",
      "failureReason": "abc123"
    }
  }
}

createS3ExportConfiguration

Description

Creates an S3 export configuration.

Response

Returns an ExportConfiguration!

Arguments
Name Description
data - CreateS3ExportConfigurationInput! The S3 export configuration.

Example

Query
mutation createS3ExportConfiguration($data: CreateS3ExportConfigurationInput!) {
  createS3ExportConfiguration(data: $data) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"data": CreateS3ExportConfigurationInput}
Response
{
  "data": {
    "createS3ExportConfiguration": {
      "id": "4",
      "interval": "EVERY_2_HOURS",
      "enabled": true,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

deleteExportConfiguration

Description

Deletes an export configuration.

Response

Returns an ExportConfiguration!

Arguments
Name Description
id - String! The ID of the export configuration.

Example

Query
mutation deleteExportConfiguration($id: String!) {
  deleteExportConfiguration(id: $id) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "deleteExportConfiguration": {
      "id": "4",
      "interval": "EVERY_2_HOURS",
      "enabled": false,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

disableExportConfiguration

Description

Disable an export configuration. Returns the configuration that was disabled.

Response

Returns an ExportConfiguration!

Arguments
Name Description
id - String! The ID of the export configuration.

Example

Query
mutation disableExportConfiguration($id: String!) {
  disableExportConfiguration(id: $id) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "disableExportConfiguration": {
      "id": 4,
      "interval": "EVERY_2_HOURS",
      "enabled": false,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

enableExportConfiguration

Description

Enable an export configuration. Returns the configuration that was enabled.

Response

Returns an ExportConfiguration!

Arguments
Name Description
id - String! The ID of the export configuration.

Example

Query
mutation enableExportConfiguration($id: String!) {
  enableExportConfiguration(id: $id) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "enableExportConfiguration": {
      "id": 4,
      "interval": "EVERY_2_HOURS",
      "enabled": false,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

updateExportJob

Description

Updates an export job.

Response

Returns an ExportJob!

Arguments
Name Description
data - UpdateExportJobInput! The export job

Example

Query
mutation updateExportJob($data: UpdateExportJobInput!) {
  updateExportJob(data: $data) {
    id
    exportConfiguration {
      ...ExportConfigurationFragment
    }
    startTimestamp
    endTimestamp
    status
    tasks {
      ...ExportJobTaskFragment
    }
    windowStart
    windowEnd
    failureReason
  }
}
Variables
{"data": UpdateExportJobInput}
Response
{
  "data": {
    "updateExportJob": {
      "id": "4",
      "exportConfiguration": ExportConfiguration,
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "status": "RUNNING",
      "tasks": [ExportJobTask],
      "windowStart": "2007-12-03T10:15:30Z",
      "windowEnd": "2007-12-03T10:15:30Z",
      "failureReason": "xyz789"
    }
  }
}

updateExportJobTask

Description

Updates an export job task.

Response

Returns an ExportJobTask!

Arguments
Name Description
data - UpdateExportJobTaskInput! The export job task

Example

Query
mutation updateExportJobTask($data: UpdateExportJobTaskInput!) {
  updateExportJobTask(data: $data) {
    id
    startTimestamp
    endTimestamp
    attempts
    offset
    limit
    status
    failureReason
  }
}
Variables
{"data": UpdateExportJobTaskInput}
Response
{
  "data": {
    "updateExportJobTask": {
      "id": "4",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "endTimestamp": "2007-12-03T10:15:30Z",
      "attempts": 123.45,
      "offset": 987,
      "limit": 123,
      "status": "RUNNING",
      "failureReason": "abc123"
    }
  }
}

updateS3ExportConfiguration

Description

Updates an S3 export configuration.

Response

Returns an ExportConfiguration!

Arguments
Name Description
data - UpdateS3ExportConfigurationInput! The S3 export configuration.

Example

Query
mutation updateS3ExportConfiguration($data: UpdateS3ExportConfigurationInput!) {
  updateS3ExportConfiguration(data: $data) {
    id
    interval
    enabled
    endpointConfiguration {
      ... on S3EndpointConfiguration {
        ...S3EndpointConfigurationFragment
      }
    }
    createdBy {
      ...UserFragment
    }
    createdAt
    updatedBy {
      ...UserFragment
    }
    updatedAt
  }
}
Variables
{"data": UpdateS3ExportConfigurationInput}
Response
{
  "data": {
    "updateS3ExportConfiguration": {
      "id": 4,
      "interval": "EVERY_2_HOURS",
      "enabled": false,
      "endpointConfiguration": S3EndpointConfiguration,
      "createdBy": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedBy": User,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Subscriptions

id

Description

The ID of the subscription record.

Response

Returns an ID!

Example

Query
subscription id {
  id
}
Response
{"data": {"id": 4}}

model

Description

The model to which this subscription grants access.

Response

Returns a SubscriptionModel!

Example

Query
subscription model {
  model {
    ... on Datasource {
      ...DatasourceFragment
    }
    ... on Project {
      ...ProjectFragment
    }
  }
}
Response
{"data": {"model": Datasource}}

name

Description

The name of the subscription (same as ID).

Response

Returns a String!

Example

Query
subscription name {
  name
}
Response
{"data": {"name": "abc123"}}

subscriber

Description

The subscriber for which this subscription grants access.

Response

Returns a Subscriber!

Example

Query
subscription subscriber {
  subscriber {
    ... on User {
      ...UserFragment
    }
    ... on Group {
      ...GroupFragment
    }
  }
}
Response
{"data": {"subscriber": User}}

type

Description

The type of the resource - SUBSCRIPTION.

Response

Returns a ResourceType!

Example

Query
subscription type {
  type
}
Response
{"data": {"type": "ATTRIBUTE"}}

Types

AbstractDatabricksContext

Description

Databricks context for query audit payloads.

Fields
Field Name Description
type - String! The technology context type: DatabricksContext.
clusterId - String Databricks cluster ID.
clusterName - String Databricks cluster name.
workspaceId - String Databricks workspace ID.
queryLanguage - String Language used within Databricks notebook cell or JDBC query.
service - DatabricksService The Databricks service utilized for the query.
Example
{
  "type": "xyz789",
  "clusterId": "abc123",
  "clusterName": "xyz789",
  "workspaceId": "abc123",
  "queryLanguage": "abc123",
  "service": "CLUSTER"
}

AccessControls

Description

Represents the access controls enforced when a user queries a data source.

Fields
Field Name Description
policySet - [Policy!] The policies applied during this query, if applicable.
entitlements - Entitlements The user entitlements applied during this query, if applicable.
Example
{
  "policySet": [Policy],
  "entitlements": Entitlements
}

Account

Description

An Immuta account type.

Fields
Field Name Description
id - ID! The ID of the account.
name - String! The name of the account.
type - ResourceType! The type of the account.
Possible Types
Account Types

User

SystemAccount

UnknownUser

UserActor

Example
{
  "id": 4,
  "name": "xyz789",
  "type": "ATTRIBUTE"
}

ActionStatus

Description

An enumeration of event statuses within the Immuta platform.

Values
Enum Value Description

SUCCESS

The event captured by the audit was successful (e.g., the data source was created successfully).

FAILURE

The event captured by the audit failed (e.g., the data source had errors being created).

UNAUTHORIZED

The event captured by the audit was unauthorized (e.g., the user was unauthorized to query the data source).
Example
"SUCCESS"

Actor

Description

A union type representing an account performing an action.

Types
Union Types

UserActor

SystemAccount

UnknownUser

Example
UserActor

AdvancedPolicy

Description

An advanced DSL policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
advanced - String! The policy DSL.
Possible Types
AdvancedPolicy Types

AdvancedPolicyApplied

AdvancedPolicyGlobal

Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "subscriptionPolicyType": "MANUAL",
  "advanced": "abc123"
}

AdvancedPolicyApplied

Description

An advanced DSL policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
global - Boolean!
policyKey - String A key/name to uniquely identify this policy.
name - String The name of the policy
id - String The id of the policy
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
mergedPolicies - [SubscriptionPolicyApplied!] The Subscription policies that were merged together to create this policy.
ruleAppliedForUser - Boolean! If this policy matched for the user running the query.
advanced - String! The policy DSL.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "global": false,
  "policyKey": "abc123",
  "name": "xyz789",
  "id": "xyz789",
  "subscriptionPolicyType": "MANUAL",
  "mergedPolicies": [SubscriptionPolicyApplied],
  "ruleAppliedForUser": true,
  "advanced": "xyz789"
}

AdvancedPolicyGlobal

Description

An advanced DSL policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
advanced - String! The policy DSL.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "abc123",
  "subscriptionPolicyType": "MANUAL",
  "advanced": "abc123"
}

AppliedPolicy

Description

The policy type when applied to a Datasource/Project.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
global - Boolean!
policyKey - String A key/name to uniquely identify this policy.
name - String The name of the policy.
id - String The id of the policy.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "abc123",
  "global": false,
  "policyKey": "abc123",
  "name": "xyz789",
  "id": "xyz789"
}

Approval

Description

The requirements for approving a data source access request.

Fields
Field Name Description
requiredPermission - String! The permission the approver must have.
specificApproverRequired - Boolean! If the requesting user must select a specific user to approve their access request.
Example
{
  "requiredPermission": "abc123",
  "specificApproverRequired": false
}

ApprovalEntitlementsPolicy

Description

A policy that requires users to have specific entitlements and receive manual approval before accessing a data source.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
approvals - [Approval!]! The approval conditions.
entitlements - SubscriptionEntitlementsConditions! The entitlements required for the user to access the data source.
Possible Types
ApprovalEntitlementsPolicy Types

ApprovalEntitlementsPolicyApplied

ApprovalEntitlementsPolicyGlobal

Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "subscriptionPolicyType": "MANUAL",
  "approvals": [Approval],
  "entitlements": SubscriptionEntitlementsConditions
}

ApprovalEntitlementsPolicyApplied

Description

A policy that requires users to have specific entitlements and receive manual approval before accessing a data source.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
global - Boolean!
policyKey - String A key/name to uniquely identify this policy.
name - String The name of the policy
id - String The id of the policy
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
mergedPolicies - [SubscriptionPolicyApplied!] The Subscription policies that were merged together to create this policy.
ruleAppliedForUser - Boolean! If this policy matched for the user running the query.
approvals - [Approval!]! The approval conditions.
entitlements - SubscriptionEntitlementsConditions! The entitlements required for the user to access the data source.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "global": true,
  "policyKey": "abc123",
  "name": "abc123",
  "id": "abc123",
  "subscriptionPolicyType": "MANUAL",
  "mergedPolicies": [SubscriptionPolicyApplied],
  "ruleAppliedForUser": true,
  "approvals": [Approval],
  "entitlements": SubscriptionEntitlementsConditions
}

ApprovalEntitlementsPolicyGlobal

Description

A policy that requires users to have specific entitlements and receive manual approval before accessing a data source.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
approvals - [Approval!]! The approval conditions.
entitlements - SubscriptionEntitlementsConditions! The entitlements required for the user to access the data source.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "abc123",
  "subscriptionPolicyType": "MANUAL",
  "approvals": [Approval],
  "entitlements": SubscriptionEntitlementsConditions
}

ApprovalPolicy

Description

An approval subscription policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
approvals - [Approval!]! The approval conditions.
Possible Types
ApprovalPolicy Types

ApprovalPolicyApplied

ApprovalPolicyGlobal

Example
{
  "type": "SUBSCRIPTION",
  "rationale": "abc123",
  "subscriptionPolicyType": "MANUAL",
  "approvals": [Approval]
}

ApprovalPolicyApplied

Description

An approval subscription policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
global - Boolean!
policyKey - String A key/name to uniquely identify this policy.
name - String The name of the policy
id - String The id of the policy
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
mergedPolicies - [SubscriptionPolicyApplied!] The Subscription policies that were merged together to create this policy.
ruleAppliedForUser - Boolean! If this policy matched for the user running the query.
approvals - [Approval!]! The approval conditions.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "global": false,
  "policyKey": "abc123",
  "name": "xyz789",
  "id": "xyz789",
  "subscriptionPolicyType": "MANUAL",
  "mergedPolicies": [SubscriptionPolicyApplied],
  "ruleAppliedForUser": true,
  "approvals": [Approval]
}

ApprovalPolicyGlobal

Description

An approval subscription policy.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
subscriptionPolicyType - SubscriptionPolicyType! Denotes the subscription policy type.
approvals - [Approval!]! The approval conditions.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "subscriptionPolicyType": "MANUAL",
  "approvals": [Approval]
}

AttributEntityType

Description

The type of entity that the attribute is being applied to or removed from (e.g., user, group).

Values
Enum Value Description

USER

GROUP

Example
"USER"

Attribute

Description

An Immuta attribute resource representation.

Fields
Field Name Description
id - ID! The name of the attribute.
name - String! The name of the attribute (same as ID).
type - ResourceType! The type of the resource - ATTRIBUTE.
values - [String!]! The values of the attribute.
Example
{
  "id": "4",
  "name": "xyz789",
  "type": "ATTRIBUTE",
  "values": ["xyz789"]
}

AttributeAppliedAuditEvent

Description

The attribute applied audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Resource!]! The target resources of the action.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - AttributeAuditPayload! The attribute audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": "4",
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "xyz789",
  "targetType": "ATTRIBUTE",
  "targets": [Resource],
  "relatedResources": [Resource],
  "auditPayload": AttributeAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

AttributeAppliedAuditEventInput

Description

The attribute applied audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
entityIdProvider - String! The identity provider for the entity.
entityType - AttributEntityType! The type of entity.
entityId - String! The ID of the entity.
attributes - [SingleAttributeInput!]! An array of attributes.
Example
{
  "sessionId": "abc123",
  "userAgent": "abc123",
  "requestId": "abc123",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actorId": "xyz789",
  "actorIdProvider": "abc123",
  "profileId": "xyz789",
  "userName": "abc123",
  "actorIp": "xyz789",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "entityIdProvider": "xyz789",
  "entityType": "USER",
  "entityId": "xyz789",
  "attributes": [SingleAttributeInput]
}

AttributeAppliedAuditPayload

Description

The attribute applied audit event payload representation.

Fields
Field Name Description
entityIdProvider - String! The identity provider for the entity.
entityType - AttributEntityType! The type of entity.
entityId - String! The ID of the entity.
attributes - [SingleAttribute!]! An array of attributes.
type - String!
version - Float The version of the Audit Event Schema
Example
{
  "entityIdProvider": "abc123",
  "entityType": "USER",
  "entityId": "abc123",
  "attributes": [SingleAttribute],
  "type": "xyz789",
  "version": 987.65
}

AttributeAuditPayload

Description

The attribute audit event payload.

Fields
Field Name Description
type - String!
version - Float The version of the Audit Event Schema
Possible Types
AttributeAuditPayload Types

AttributeAppliedAuditPayload

AttributeRemovedAuditPayload

Example
{"type": "xyz789", "version": 123.45}

AttributeRemovedAuditEvent

Description

The attribute applied audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Resource!]! The target resources of the action.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - AttributeAuditPayload! The attribute audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": 4,
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "abc123",
  "targetType": "ATTRIBUTE",
  "targets": [Resource],
  "relatedResources": [Resource],
  "auditPayload": AttributeAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

AttributeRemovedAuditEventInput

Description

The attribute removed audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
entityIdProvider - String! The identity provider for the entity.
entityType - AttributEntityType! The type of entity.
entityId - String! The ID of the entity.
attributes - [SingleAttributeInput!]! An array of attributes.
Example
{
  "sessionId": "xyz789",
  "userAgent": "abc123",
  "requestId": "abc123",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actorId": "xyz789",
  "actorIdProvider": "xyz789",
  "profileId": "abc123",
  "userName": "xyz789",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "entityIdProvider": "abc123",
  "entityType": "USER",
  "entityId": "xyz789",
  "attributes": [SingleAttributeInput]
}

AttributeRemovedAuditPayload

Description

The attribute applied audit event payload representation.

Fields
Field Name Description
entityIdProvider - String! The identity provider for the entity.
entityType - AttributEntityType! The type of entity.
entityId - String! The ID of the entity.
attributes - [SingleAttribute!]! An array of attributes.
type - String!
version - Float The version of the Audit Event Schema
Example
{
  "entityIdProvider": "xyz789",
  "entityType": "USER",
  "entityId": "xyz789",
  "attributes": [SingleAttribute],
  "type": "abc123",
  "version": 987.65
}

AuditEvent

Description

An Immuta audit event.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Resource!]! The target resources of the action.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - AuditPayload! The audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": 4,
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "xyz789",
  "targetType": "ATTRIBUTE",
  "targets": [Resource],
  "relatedResources": [Resource],
  "auditPayload": AuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

AuditEventAction

Description

An enumeration of audit event actions within the Immuta platform.

Values
Enum Value Description

ATTRIBUTE_APPLY

ATTRIBUTE_REMOVE

AUTHENTICATE

CATALOG_SYNC

CREATE

DATASOURCE_APPLY

DATASOURCE_REMOVE

DELETE

DISABLE

PURPOSE_ACKNOWLEDGE

PURPOSE_APPROVE

PURPOSE_DENY

QUERY

SUBSCRIPTION_REQUEST_APPROVE

SUBSCRIPTION_REQUEST_DENY

TAG_APPLY

TAG_REMOVE

UPDATE

UPSERT

Example
"ATTRIBUTE_APPLY"

AuditEventSearchCriteriaInput

Description

The audit event search criteria input.

Fields
Input Field Description
offset - Int Audit event search criteria to return a set of audit events after the first audit event. Default is 0. Default = 0
limit - Int Audit event search criteria to return a maximum number of audit events. Default is 10. Default = 10
sortBy - SortBy Audit event search criteria value to apply the ordering of the returned audit events.
order - SortOrder Audit search criteria to specify the sort order for the returned audit events. Default to DESC (descending). Default = DESC
startDate - DateTime Audit search criteria for the start date eventTimestamp in the returned audit events.
endDate - DateTime Audit search criteria for the end date eventTimestamp in the returned audit events.
Example
{
  "offset": 987,
  "limit": 987,
  "sortBy": "EVENT_TIMESTAMP",
  "order": "ASC",
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z"
}

AuditPayload

BigInt

Description

The BigInt scalar type represents non-fractional signed whole numeric values.

Example
{}

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

Column

Description

An Immuta column resource representation.

Fields
Field Name Description
id - ID! The ID of the data source.
name - String! The name of the data source.
type - ResourceType! The type of the resource - COLUMN.
columnName - String! The name of a column on the datasource.
Example
{
  "id": 4,
  "name": "abc123",
  "type": "ATTRIBUTE",
  "columnName": "abc123"
}

ColumnAccessed

Description

The column accessed.

Fields
Field Name Description
name - String! The name of the column accessed.
tags - [ObjectAccessedTag!] The column accessed tags.
securityProfile - SecurityProfile The column accessed security profile.
Example
{
  "name": "xyz789",
  "tags": [ObjectAccessedTag],
  "securityProfile": SecurityProfile
}

ColumnAccessedInput

Description

The column accessed.

Fields
Input Field Description
name - String! The name of the column accessed.
tags - [ObjectAccessedTagInput!] The column accessed tags.
securityProfile - SecurityProfileInput The column accessed security profile.
Example
{
  "name": "abc123",
  "tags": [ObjectAccessedTagInput],
  "securityProfile": SecurityProfileInput
}

ConditionalMaskingRule

Description

Masking rule that can be conditionally applied.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "conditionalPredicate": "abc123"
}

ConditionalMaskingRuleApplied

Description

Masking rule that can be conditionally applied.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
ruleAppliedForUser - Boolean! If this rule matched for the user running the query.
fields - [String!]! The columns this rule applies to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "ruleAppliedForUser": false,
  "fields": ["xyz789"],
  "conditionalPredicate": "abc123"
}

ConditionalMaskingRuleGlobal

Description

Masking rule that can be conditionally applied.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
columnCondition - GlobalColumnCondition! The condition(s) for what columns the policy will apply to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "columnCondition": GlobalColumnCondition,
  "conditionalPredicate": "abc123"
}

ConditionsOperator

Description

Denotes whether all or just some conditions need to be true.

Values
Enum Value Description

ALL

ANY

Example
"ALL"

Connection

Description

An Immuta connection resource representation.

Fields
Field Name Description
id - ID! The ID of the connection associated with the data source.
name - String! An alias for connectionKey.
type - ResourceType! The type of the resource - CONNECTION.
connectionKey - String! The connection key associated with the data source.
Example
{
  "id": 4,
  "name": "abc123",
  "type": "ATTRIBUTE",
  "connectionKey": "xyz789"
}

ConstantMaskingRule

Description

Masking with a constant value.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
constant - StringOrInt! The constant to replace the values with.
Possible Types
ConstantMaskingRule Types

ConstantMaskingRuleApplied

ConstantMaskingRuleGlobal

Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "conditionalPredicate": "xyz789",
  "constant": StringOrInt
}

ConstantMaskingRuleApplied

Description

Masking with a constant value.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
ruleAppliedForUser - Boolean! If this rule matched for the user running the query.
fields - [String!]! The columns this rule applies to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
constant - StringOrInt! The constant to replace the values with.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "ruleAppliedForUser": false,
  "fields": ["abc123"],
  "conditionalPredicate": "abc123",
  "constant": StringOrInt
}

ConstantMaskingRuleGlobal

Description

Masking with a constant value.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
columnCondition - GlobalColumnCondition! The condition(s) for what columns the policy will apply to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
constant - StringOrInt! The constant to replace the values with.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "columnCondition": GlobalColumnCondition,
  "conditionalPredicate": "abc123",
  "constant": StringOrInt
}

CreateExportJobTaskInput

Description

The export job task to create.

Fields
Input Field Description
exportJobId - String! The export job ID.
offset - Int! The starting point for the audit events handled by the task.
limit - Int! The maximum limit of the number of audit events handled by the task.
Example
{
  "exportJobId": "abc123",
  "offset": 987,
  "limit": 987
}

CreateS3ExportConfigurationInput

Description

The S3 export configuration to create.

Fields
Input Field Description
interval - Interval! The interval of the export.
bucket - String! The S3 bucket name.
path - String The S3 bucket path - optional.
region - String! The S3 bucket region.
accessKeyId - String! The AWS Access Key ID.
secretAccessKey - String! The AWS Secret Access Key.
Example
{
  "interval": "EVERY_2_HOURS",
  "bucket": "abc123",
  "path": "xyz789",
  "region": "xyz789",
  "accessKeyId": "xyz789",
  "secretAccessKey": "abc123"
}

CustomFunctionMaskingRule

Description

Masking with custom SQL function.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
sqlFunction - String! The SQL function definition.
Possible Types
CustomFunctionMaskingRule Types

CustomFunctionMaskingRuleApplied

CustomFunctionMaskingRuleGlobal

Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "conditionalPredicate": "xyz789",
  "sqlFunction": "xyz789"
}

CustomFunctionMaskingRuleApplied

Description

Masking with custom SQL function.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
ruleAppliedForUser - Boolean! If this rule matched for the user running the query.
fields - [String!]! The columns this rule applies to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
sqlFunction - String! The SQL function definition.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "ruleAppliedForUser": true,
  "fields": ["abc123"],
  "conditionalPredicate": "abc123",
  "sqlFunction": "abc123"
}

CustomFunctionMaskingRuleGlobal

Description

Masking with custom SQL function.

Fields
Field Name Description
type - DataRuleType! The type of masking used in this rule.
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
columnCondition - GlobalColumnCondition! The condition(s) for what columns the policy will apply to.
conditionalPredicate - String SQL where clause to conditionally apply this masking rule.
sqlFunction - String! The SQL function definition.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "columnCondition": GlobalColumnCondition,
  "conditionalPredicate": "abc123",
  "sqlFunction": "abc123"
}

DataEntitlementsConditions

Description

The entitlements required for the user to access the data source.

Fields
Field Name Description
entitlementsRequirement - ConditionsOperator! Denotes whether the user needs all entitlements or just one of them.
groups - [String!]! The required groups the user must be in.
attributes - [SingleAttribute!]! The required attributes the user must have.
purposes - [String!]! The required purposes the user must be acting under.
Example
{
  "entitlementsRequirement": "ALL",
  "groups": ["abc123"],
  "attributes": [SingleAttribute],
  "purposes": ["xyz789"]
}

DataPolicy

Description

The common data policy fields.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
dataPolicyType - DataPolicyType! What type of data policy this represents.
rules - [DataRule!]! The rules for this policy.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "dataPolicyType": "MASKING",
  "rules": [DataRule]
}

DataPolicyApplied

Description

The common data policy fields type when applied to a Datasource.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
dataPolicyType - DataPolicyType! What type of data policy this represents.
rules - [DataRuleInQuery!]! The rules for this policy.
global - Boolean!
policyKey - String The key for the policy for usage with the v2 api
name - String The name of the policy
id - String The id of the policy
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "abc123",
  "dataPolicyType": "MASKING",
  "rules": [DataRuleInQuery],
  "global": false,
  "policyKey": "xyz789",
  "name": "abc123",
  "id": "xyz789"
}

DataPolicyGlobal

Description

The common data policy fields.

Fields
Field Name Description
type - PolicyType! If the policy is a data or subscription policy.
rationale - String The description of the policy.
dataPolicyType - DataPolicyType! What type of data policy this represents.
rules - [DataRule!]! The rules for this policy.
Example
{
  "type": "SUBSCRIPTION",
  "rationale": "xyz789",
  "dataPolicyType": "MASKING",
  "rules": [DataRule]
}

DataPolicyType

Description

The type of data policy.

Values
Enum Value Description

MASKING

ROW_RESTRICTION

TIME

MINIMIZATION

PURPOSE_RESTRICTION

EXEMPTION

DIFFERENTIAL_PRIVACY

Example
"MASKING"

DataRule

DataRuleInQuery

Description

Data rule when the policy was used in a query

Fields
Field Name Description
type - DataRuleType!
exceptions - DataEntitlementsConditions If these conditions are met, the rule will not apply to this user.
inclusions - DataEntitlementsConditions If these conditions are met, the rule will apply to this user.
ruleAppliedForUser - Boolean! If this rule matched for the user running the query.
Example
{
  "type": "MASKING_HASH",
  "exceptions": DataEntitlementsConditions,
  "inclusions": DataEntitlementsConditions,
  "ruleAppliedForUser": false
}

DataRuleType

Description

The type of data rule.

Values
Enum Value Description

MASKING_HASH

MASKING_NULL

MASKING_CONSTANT

MASKING_CUSTOM_FUNCTION

MASKING_REGEX

MASKING_RANDOMIZED_RESPONSE

MASKING_ROUNDING

MASKING_K_ANONYMIZATION

MASKING_FORMAT_PRESERVING_MASKING

MASKING_REVERSIBLE

WHERE

SHOW_ROWS_NEVER

TIME

MINIMIZATION

PURPOSE_RESTRICTION

EXEMPTION

DIFFERENTIAL_PRIVACY

Example
"MASKING_HASH"

DatabricksAccountInformation

Description

Databricks Account Information

Fields
Field Name Description
username - String Databricks username.
id - String Databricks Account ID
Example
{
  "username": "xyz789",
  "id": "abc123"
}

DatabricksContext

Description

Databricks context for query audit payloads.

Fields
Field Name Description
type - String! The technology context type.
clusterId - String Databricks cluster ID.
clusterName - String Databricks cluster name.
workspaceId - String Databricks workspace ID.
queryLanguage - String Language used within Databricks notebook cell or JDBC query.
service - DatabricksService The Databricks service utilized for the query.
queryText - String Text used within Databricks notebook cell or JDBC query.
pathUris - [String!] Databricks cluster path URIs.
metastoreTables - [String!] Databricks metastore tables.
immutaPluginVersion - String Version of the Immuta Databricks plugin.
Example
{
  "type": "xyz789",
  "clusterId": "abc123",
  "clusterName": "abc123",
  "workspaceId": "abc123",
  "queryLanguage": "abc123",
  "service": "CLUSTER",
  "queryText": "xyz789",
  "pathUris": ["abc123"],
  "metastoreTables": ["abc123"],
  "immutaPluginVersion": "xyz789"
}

DatabricksQueryAuditEventInput

Description

The audit event input from Databricks queries.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasources - [DatasourceInput!]! The data sources used in this query.
queryId - String! Unique ID of the query.
query - String The executed query.
startTime - DateTime! The start time of the query.
endTime - DateTime The end time of the query.
duration - Float The duration of the query in milliseconds.
impersonatedBy - String The user who directed impersonation, if this query used impersonation.
policySet - JSON The policies applied during this query, if applicable.
entitlements - EntitlementsInput The user entitlements applied during this query, if applicable.
objectsAccessed - [ObjectAccessedInput!]! The objects accessed in the query explicitly or through shortcuts, such as using an asterisk (*).
securityProfile - SecurityProfileInput The query security profile.
errorCode - String The error code of the query, if applicable.
clusterId - String Databricks cluster ID.
clusterName - String Databricks cluster name.
workspaceId - String Databricks workspace ID.
pathUris - [String!] Databricks cluster path URIs.
metastoreTables - [String!] Databricks metastore tables.
queryLanguage - String Language used within Databricks notebook cell or JDBC query.
queryText - String Text used within Databricks notebook cell or JDBC query.
immutaPluginVersion - String Version of the Immuta Databricks plugin.
databricksAccountId - String Databricks Account ID
databricksUsername - String Databricks username.
warehouseId - String Databricks warehouse ID.
notebookId - String Databricks notebook id
host - String Databricks hostname.
clientIp - String The IP address that the query was executed from.
service - DatabricksService The Databricks service utilized for the query.
Example
{
  "sessionId": "xyz789",
  "userAgent": "abc123",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actorId": "xyz789",
  "actorIdProvider": "xyz789",
  "profileId": "xyz789",
  "userName": "xyz789",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "datasources": [DatasourceInput],
  "queryId": "xyz789",
  "query": "abc123",
  "startTime": "2007-12-03T10:15:30Z",
  "endTime": "2007-12-03T10:15:30Z",
  "duration": 123.45,
  "impersonatedBy": "abc123",
  "policySet": {},
  "entitlements": EntitlementsInput,
  "objectsAccessed": [ObjectAccessedInput],
  "securityProfile": SecurityProfileInput,
  "errorCode": "xyz789",
  "clusterId": "xyz789",
  "clusterName": "xyz789",
  "workspaceId": "abc123",
  "pathUris": ["abc123"],
  "metastoreTables": ["abc123"],
  "queryLanguage": "abc123",
  "queryText": "abc123",
  "immutaPluginVersion": "abc123",
  "databricksAccountId": "abc123",
  "databricksUsername": "abc123",
  "warehouseId": "xyz789",
  "notebookId": "abc123",
  "host": "abc123",
  "clientIp": "xyz789",
  "service": "CLUSTER"
}

DatabricksService

Description

The Databricks service utilized for the query.

Values
Enum Value Description

CLUSTER

WAREHOUSE

PLUGIN

Example
"CLUSTER"

DatabricksUnityCatalogContext

Description

Databricks context for query audit payloads.

Fields
Field Name Description
type - String! The technology context type.
clusterId - String Databricks cluster ID.
clusterName - String Databricks cluster name.
workspaceId - String Databricks workspace ID.
queryLanguage - String Language used within Databricks notebook cell or JDBC query.
service - DatabricksService The Databricks service utilized for the query.
warehouseId - String Databricks warehouse ID.
notebookId - String Databricks notebook id
account - DatabricksAccountInformation Databricks Account Information
host - String Databricks hostname.
clientIp - String The IP address that the query was executed from.
Example
{
  "type": "abc123",
  "clusterId": "xyz789",
  "clusterName": "abc123",
  "workspaceId": "abc123",
  "queryLanguage": "xyz789",
  "service": "CLUSTER",
  "warehouseId": "abc123",
  "notebookId": "abc123",
  "account": DatabricksAccountInformation,
  "host": "abc123",
  "clientIp": "abc123"
}

Datasource

Description

An Immuta data source resource representation.

Fields
Field Name Description
id - ID! The ID of the data source.
name - String! The name of the data source.
type - ResourceType! The type of the resource - DATASOURCE.
technology - DatasourceTechnology! The technology of the data source.
Example
{
  "id": 4,
  "name": "xyz789",
  "type": "ATTRIBUTE",
  "technology": "AMAZON_ATHENA"
}

DatasourceAuditPayload

Description

The data source audit event payload.

Fields
Field Name Description
type - String!
version - Float The version of the Audit Event Schema
Example
{"type": "abc123", "version": 123.45}

DatasourceCatalog

Description

The representation of a data source in terms of properties that can be specified by a catalog.

Fields
Field Name Description
catalogId - String The ID of the associated catalog, if applicable.
description - String The short description specified by the catalog provider for this data source.
documentation - String The markdown documentation specified by the catalog provider for this data source.
tableTags - [String!] The list of tags specified by the catalog provider for this data source.
dictionary - [DatasourceCatalogDictionaryColumn!] The set of data source catalog columns.
Example
{
  "catalogId": "abc123",
  "description": "xyz789",
  "documentation": "xyz789",
  "tableTags": ["abc123"],
  "dictionary": [DatasourceCatalogDictionaryColumn]
}

DatasourceCatalogDictionaryColumn

Description

A column in a data source catalog dictionary.

Fields
Field Name Description
columnName - String! The name of a column on the datasource.
description - String The short description specified by the catalog provider for this column.
tags - [String!]! The list of tags specified by the catalog provider for this column.
Example
{
  "columnName": "xyz789",
  "description": "abc123",
  "tags": ["xyz789"]
}

DatasourceCatalogDictionaryColumnInput

Description

A column in a data source catalog dictionary.

Fields
Input Field Description
columnName - String! The name of a column on the datasource.
description - String The short description specified by the catalog provider for this column.
tags - [String!]! The list of tags specified by the catalog provider for this column.
Example
{
  "columnName": "xyz789",
  "description": "xyz789",
  "tags": ["abc123"]
}

DatasourceCatalogInput

Description

The representation of a data source in terms of properties that can be specified by a catalog.

Fields
Input Field Description
catalogId - String The ID of the associated catalog, if applicable.
description - String The short description specified by the catalog provider for this data source.
documentation - String The markdown documentation specified by the catalog provider for this data source.
tableTags - [String!] The list of tags specified by the catalog provider for this data source.
dictionary - [DatasourceCatalogDictionaryColumnInput!] The set of data source catalog columns.
Example
{
  "catalogId": "xyz789",
  "description": "abc123",
  "documentation": "abc123",
  "tableTags": ["abc123"],
  "dictionary": [DatasourceCatalogDictionaryColumnInput]
}

DatasourceCatalogSync

Description

The before and after state from a data source catalog sync.

Fields
Field Name Description
before - DatasourceCatalog! The data source catalog state before this sync. Note that fields 'tableTags' and 'dictionary' will be null if unchanged.
after - DatasourceCatalog! The data source catalog state after this sync. Note that fields 'tableTags' and 'dictionary' will be null if unchanged.
Example
{
  "before": DatasourceCatalog,
  "after": DatasourceCatalog
}

DatasourceCatalogSyncInput

Description

The before and after state from a data source catalog sync.

Fields
Input Field Description
before - DatasourceCatalogInput! The data source catalog state before this sync. Note that fields 'tableTags' and 'dictionary' will be null if unchanged.
after - DatasourceCatalogInput! The data source catalog state after this sync. Note that fields 'tableTags' and 'dictionary' will be null if unchanged.
Example
{
  "before": DatasourceCatalogInput,
  "after": DatasourceCatalogInput
}

DatasourceCatalogSyncedAuditEvent

Description

The data source catalog synced audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Datasource!]! The target data sources.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - DatasourceAuditPayload! The data source audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": 4,
  "sessionId": "xyz789",
  "userAgent": "xyz789",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "xyz789",
  "targetType": "ATTRIBUTE",
  "targets": [Datasource],
  "relatedResources": [Resource],
  "auditPayload": DatasourceAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

DatasourceCatalogSyncedAuditEventInput

Description

The data source catalog synced audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasourceId - String! The ID of the data source.
changes - DatasourceCatalogSyncInput! The data source catalog state before and after this sync.
Example
{
  "sessionId": "xyz789",
  "userAgent": "abc123",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actorId": "abc123",
  "actorIdProvider": "xyz789",
  "profileId": "xyz789",
  "userName": "abc123",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": "4",
  "datasourceId": "abc123",
  "changes": DatasourceCatalogSyncInput
}

DatasourceCatalogSyncedAuditPayload

Description

The data source catalog synced audit event payload representation.

Fields
Field Name Description
type - String!
version - Float The version of the Audit Event Schema
datasourceId - String! The ID of the data source.
changes - DatasourceCatalogSync! The data source catalog state before and after this sync.
Example
{
  "type": "abc123",
  "version": 123.45,
  "datasourceId": "abc123",
  "changes": DatasourceCatalogSync
}

DatasourceCreatedAuditEvent

Description

The data source created audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Datasource!]! The target data sources.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - DatasourceAuditPayload! The data source audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": "4",
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actor": UserActor,
  "actorIp": "xyz789",
  "tenantId": "abc123",
  "targetType": "ATTRIBUTE",
  "targets": [Datasource],
  "relatedResources": [Resource],
  "auditPayload": DatasourceAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

DatasourceCreatedAuditEventInput

Description

The data source created audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasourceId - String The ID of the data source.
name - String! The name of the data source.
description - String The short description of the data source.
documentation - String The data source documentation rendered in Markdown.
expiration - DateTime The time at which this data source will expire.
columnDetectionEnabled - Boolean True if column detection was configured to run on this data source.
disabled - Boolean True if the data source is disabled.
blobHandlerType - String! The technology of the data source as used by the Immuta Web Service API.
connectionId - String The ID of the connection associated with the data source.
table - String! The name of the table that backs this data source.
schema - String The name of the schema that backs this data source.
sensitiveDataDiscoveryEnabled - Boolean True if Sensitive Data Discovery (SDD) was configured to run on this data source.
Example
{
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actorId": "xyz789",
  "actorIdProvider": "xyz789",
  "profileId": "xyz789",
  "userName": "xyz789",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "datasourceId": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "documentation": "abc123",
  "expiration": "2007-12-03T10:15:30Z",
  "columnDetectionEnabled": false,
  "disabled": true,
  "blobHandlerType": "xyz789",
  "connectionId": "abc123",
  "table": "abc123",
  "schema": "abc123",
  "sensitiveDataDiscoveryEnabled": false
}

DatasourceCreatedAuditPayload

Description

The data source created audit event payload representation.

Fields
Field Name Description
name - String! The name of the data source.
description - String The short description of the data source.
documentation - String The data source documentation rendered in Markdown.
expiration - DateTime The time at which this data source will expire.
columnDetectionEnabled - Boolean True if column detection was configured to run on this data source.
disabled - Boolean True if the data source is disabled.
type - String!
version - Float The version of the Audit Event Schema
technology - DatasourceTechnology! The technology of the data source.
connectionId - String The ID of the connection associated with the data source.
table - String! The name of the table that backs this data source.
schema - String The name of the schema that backs this data source.
sensitiveDataDiscoveryEnabled - Boolean True if Sensitive Data Discovery (SDD) was configured to run on this data source.
Example
{
  "name": "xyz789",
  "description": "abc123",
  "documentation": "abc123",
  "expiration": "2007-12-03T10:15:30Z",
  "columnDetectionEnabled": true,
  "disabled": true,
  "type": "xyz789",
  "version": 123.45,
  "technology": "AMAZON_ATHENA",
  "connectionId": "xyz789",
  "table": "xyz789",
  "schema": "abc123",
  "sensitiveDataDiscoveryEnabled": false
}

DatasourceDeletedAuditEvent

Description

The data source deleted audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Datasource!]! The target data sources.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - DatasourceAuditPayload! The data source audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": 4,
  "sessionId": "abc123",
  "userAgent": "abc123",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actor": UserActor,
  "actorIp": "xyz789",
  "tenantId": "xyz789",
  "targetType": "ATTRIBUTE",
  "targets": [Datasource],
  "relatedResources": [Resource],
  "auditPayload": DatasourceAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

DatasourceDeletedAuditEventInput

Description

The data source deleted audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasourceId - String! The ID of the data source.
name - String The name of the data source.
blobHandlerType - String The technology of the data source as used by the Immuta Web Service API.
Example
{
  "sessionId": "xyz789",
  "userAgent": "abc123",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actorId": "xyz789",
  "actorIdProvider": "xyz789",
  "profileId": "abc123",
  "userName": "xyz789",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "datasourceId": "abc123",
  "name": "abc123",
  "blobHandlerType": "xyz789"
}

DatasourceDeletedAuditPayload

Description

The data source deleted audit event payload representation.

Fields
Field Name Description
datasourceId - String! The ID of the data source.
name - String The name of the data source.
technology - DatasourceTechnology The technology of the data source as used by the Immuta Web Service API.
type - String!
version - Float The version of the Audit Event Schema
Example
{
  "datasourceId": "abc123",
  "name": "xyz789",
  "technology": "AMAZON_ATHENA",
  "type": "abc123",
  "version": 123.45
}

DatasourceDisabledAuditEvent

Description

The data source disabled audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Datasource!]! The target data sources.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - DatasourceAuditPayload! The data source audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": 4,
  "sessionId": "xyz789",
  "userAgent": "xyz789",
  "requestId": "xyz789",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "abc123",
  "targetType": "ATTRIBUTE",
  "targets": [Datasource],
  "relatedResources": [Resource],
  "auditPayload": DatasourceAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

DatasourceDisabledAuditEventInput

Description

The data source disabled audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasourceId - String! The ID of the data source.
name - String The name of the data source.
blobHandlerType - String The technology of the data source as used by the Immuta Web Service API.
Example
{
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "xyz789",
  "actorId": "abc123",
  "actorIdProvider": "abc123",
  "profileId": "xyz789",
  "userName": "xyz789",
  "actorIp": "xyz789",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": 4,
  "datasourceId": "abc123",
  "name": "abc123",
  "blobHandlerType": "abc123"
}

DatasourceDisabledAuditPayload

Description

The data source disabled audit event payload representation.

Fields
Field Name Description
datasourceId - String! The ID of the data source.
name - String The name of the data source.
technology - DatasourceTechnology The technology of the data source as used by the Immuta Web Service API.
type - String!
version - Float The version of the Audit Event Schema
Example
{
  "datasourceId": "abc123",
  "name": "xyz789",
  "technology": "AMAZON_ATHENA",
  "type": "xyz789",
  "version": 987.65
}

DatasourceInput

Description

The data source.

Fields
Input Field Description
id - String! The ID of the data source used in this query.
name - String The name of the data source used in this query.
Example
{
  "id": "abc123",
  "name": "xyz789"
}

DatasourceTechnology

Description

The technology of the data source.

Values
Enum Value Description

AMAZON_ATHENA

AMAZON_REDSHIFT

AMAZON_S3

APACHE_HDFS

APACHE_HIVE

APACHE_IMPALA

AZURE_BLOB_STORAGE

AZURE_DL_STORAGE_GEN2

AZURE_SYNAPSE_ANALYTICS

BLACKLYNX

CUSTOM

DATABRICKS

ELASTIC

GOOGLE_BIGQUERY

GREENPLUM

IBM_DB2

IBM_DB2_ZOS

JETHRO

KDB

MARIADB

MICROSOFT_SQL_SERVER

MONGODB

MYSQL

NETEZZA

ORACLE

PERSISTED

POSTGRESQL

PRESTO

SAP_HANA

SINGLESTORE

SNOWFLAKE

SOLR

STARBURST_TRINO

SYBASE_ASE

TERADATA

VERTICA

YELLOWBRICK

Example
"AMAZON_ATHENA"

DatasourceUpdatedAuditEvent

Description

The data source updated audit event representation.

Fields
Field Name Description
id - ID! The ID of the audit event.
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
action - AuditEventAction! The action that was performed.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actor - Actor! The user who performed the action.
actorIp - String The IP address of the actor.
tenantId - String! The ID of the tenant.
targetType - ResourceType! The type of the target resources (e.g., DATASOURCE, POLICY, PURPOSE, PROJECT, TAG, USER).
targets - [Datasource!]! The target data sources.
relatedResources - [Resource!]! Resources related to the action that are not targets.
auditPayload - DatasourceAuditPayload! The data source audit event payload.
eventTimestamp - DateTime! The timestamp of the event.
receivedTimestamp - DateTime! The timestamp the audit event was received and stored by Immuta.
Example
{
  "id": "4",
  "sessionId": "abc123",
  "userAgent": "abc123",
  "requestId": "abc123",
  "action": "ATTRIBUTE_APPLY",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actor": UserActor,
  "actorIp": "abc123",
  "tenantId": "xyz789",
  "targetType": "ATTRIBUTE",
  "targets": [Datasource],
  "relatedResources": [Resource],
  "auditPayload": DatasourceAuditPayload,
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "receivedTimestamp": "2007-12-03T10:15:30Z"
}

DatasourceUpdatedAuditEventInput

Description

The data source updated audit event input representation.

Fields
Input Field Description
sessionId - String The session ID of the actor who performed the action.
userAgent - String The user agent application used by the actor who performed the action.
requestId - String The API request ID that triggered the action, if applicable.
actionStatus - ActionStatus! The status of the action.
actionStatusReason - String The reason for the action status, if applicable (e.g., a listing of errors that occurred completing the action).
actorId - String! The ID of the user who performed the action.
actorIdProvider - String! The identity provider of the actor.
profileId - String The ID of the user's profile.
userName - String The name of the user.
actorIp - String The IP address of the actor.
eventTimestamp - DateTime! The timestamp of the event.
id - ID The ID of the audit event.
datasourceId - String! The ID of the data source.
name - String The name of the data source.
description - String The short description of the data source.
documentation - String The data source documentation rendered in Markdown.
expiration - DateTime The time at which this data source will expire.
columnDetectionEnabled - Boolean True if column detection was configured to run on this data source.
disabled - Boolean True if the data source is disabled.
Example
{
  "sessionId": "abc123",
  "userAgent": "xyz789",
  "requestId": "xyz789",
  "actionStatus": "SUCCESS",
  "actionStatusReason": "abc123",
  "actorId": "abc123",
  "actorIdProvider": "xyz789",
  "profileId": "xyz789",
  "userName": "xyz789",
  "actorIp": "abc123",
  "eventTimestamp": "2007-12-03T10:15:30Z",
  "id": "4",
  "datasourceId": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "documentation": "xyz789",
  "expiration": "2007-12-03T10:15:30Z",
  "columnDetectionEnabled": true,
  "disabled": true
}

DatasourceUpdatedAuditPayload