Schema Registry Authentication and Authorization Auditable Event Methods on Confluent Cloud

An auditable event is an authentication or authorization action on Confluent Cloud Schema Registry, Stream Catalog, or exporters for Schema Linking that generates a message that Confluent Cloud stores as a record in the audit log.

For management and operations events for Schema Registry, see Schema Registry Management and Operations Auditable Event Methods on Confluent Cloud.

Schema Registry authentication

The following authentication actions or operations on Confluent Cloud Schema Registry, Confluent Cloud Stream Catalog, and exporters for Schema Linking on Confluent Cloud generate auditable event messages for the io.confluent.sg.server/authentication event.

Method name	Action triggering an auditable event message
schema-registry.Authentication	A request to authenticate to Schema Registry using an API key or token.

schema-registry.Authentication

The schema-registry.Authentication event is generated by a request for authentication to Schema Registry using an API key or token.

To view an example event message, expand the following dropdown:

Success

{
  "datacontenttype": "application/json",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "schema-registry.Authentication",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "bc64d0fb-84b7-4467-a36b-3ad3cd8c188d"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-qjygy6"
            }
          ]
        },
        "resource": {
          "type": "SCHEMA_REGISTRY",
          "resourceId": "lsrc-gx9kdv"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "confluentUser": {
          "resourceId": "u-y35x87"
        }
      },
      "result": "SUCCESS",
      "credentials": {
        "idSecretCredentials": {
          "credentialId": "7TBXED2PT5CAKIGK"
        },
        "mechanism": "HTTP_BASIC"
      }
    },
    "requestMetadata": {
      "requestId": [
        "8406167c-8c05-11ed-8f14-5f38e5250914"
      ]
    },
    "resourceName": "crn://confluent.cloud/organization=bc64d0fb-84b7-4467-a36b-3ad3cd8c188d/environment=env-qjygy6/schema-registry=lsrc-gx9kdv"
  },
  "subject": "crn://confluent.cloud/organization=bc64d0fb-84b7-4467-a36b-3ad3cd8c188d/environment=env-qjygy6/schema-registry=lsrc-gx9kdv",
  "specversion": "1.0",
  "id": "7fced40b-f893-429e-aa08-be584268379a",
  "source": "crn://confluent.cloud/",
  "time": "2023-01-04T07:58:03.708Z",
  "type": "io.confluent.sg.server/authentication"
}

Schema Registry authorization

The following authorization actions, or operations, on Schema Registry generate auditable event messages for the io.confluent.sg.server/authorization event type.

Each of the following auditable event methods is generated by a request to the Schema Registry API. Each method listed includes the action triggering an auditable event message and the associated Schema Registry API request.

Method name	Action triggering an auditable event message
schema-registry.RegisterSchema	A request to register a new schema under the specified subject. POST /subjects/(string: subject)/versions
schema-registry.LookUpSchemaUnderSubject	A request to check if a schema has already been registered under the specified subject. POST /subjects/(string: subject)
schema-registry.DeleteSchemaVersion	A request to delete a specific version of the schema registered under this subject. DELETE /subjects/(string: subject)/versions/(versionId: version)
schema-registry.DeleteSubject	A request to delete the specified subject and its associated compatibility level if registered. DELETE /subjects/(string: subject)
schema-registry.UpdateSubjectConfig	A request to update the subject compatibility level. PUT /config/(string: subject)
schema-registry.DeleteSubjectConfig	A request to delete the specified subject-level compatibility level configuration and revert to the global default. DELETE /config/(string: subject)
schema-registry.UpdateGlobalConfig	A request to update the global compatibility level. PUT /config
schema-registry.DeleteGlobalConfig	A request to delete the global compatibility level configuration and revert to the default. DELETE /config
schema-registry.UpdateSubjectMode	A request to update the mode for the specified subject. PUT /mode/(string: subject)
schema-registry.DeleteSubjectMode	A request to delete the specified subject-level compatibility level configuration and revert to the global default. DELETE /mode/(string: subject)
schema-registry.UpdateGlobalMode	A request to update global mode. PUT /mode

Stream Catalog authorization

The following authorization actions, or operations, on Confluent Cloud Stream Catalog generate auditable event messages for the io.confluent.sg.server/authorization event type.

Each of the following auditable event methods is generated by a request to the Stream Catalog API. Each method listed includes the action triggering an auditable event message and the associated Stream Catalog API request.

Method name	Action triggering an auditable event message
schema-registry.PartialEntityUpdate	A request to partially update an entity. PUT catalog/v1/entity
schema-registry.CreateTags	A request to create tags. POST catalog/v1/entity/tags
schema-registry.UpdateTags	A request to update tags. PUT catalog/v1/entity/tags
schema-registry.DeleteTag	A request to delete a tag on an entity. DELETE catalog/v1/entity/type/(string: typeName)/name/(string: qualifiedName)/tags/(string: tagName)
schema-registry.CreateBusinessMetadata	A request to create business metadata. POST catalog/v1/entity/businessmetadata
schema-registry.UpdateBusinessMetadata	A request to update business metadata. PUT catalog/v1/entity/businessmetadata
schema-registry.DeleteBusinessMetadata	A request to delete a business metadata on an entity. DELETE catalog/v1/entity/type/(string: typeName)/name/(string: qualifiedName)/businessmetadata/(string: bmName)
schema-registry.SearchCatalogUsingBasicQuery	A request to retrieve data for the specified full text query. GET catalog/v1/search/basic
schema-registry.SearchCatalogUsingAttributes	A request to retrieve data for the specified attribute search query. GET catalog/v1/search/attribute
schema-registry.CreateTagDefs	A request to create tag definitions. POST catalog/v1/types/tagdefs
schema-registry.UpdateTagDefs	A request to update tag definitions. PUT catalog/v1/types/tagdefs
schema-registry.DeleteTagDef	A request to delete tag definitions identified by their names. DELETE catalog/v1/types/tagdefs/(string: tagName)
schema-registry.CreateBusinessMetadataDefs	A request to create business metadata definitions. POST catalog/v1/types/businessmetadatadefs
schema-registry.UpdateBusinessMetadataDefs	A request to update business metadata definitions. PUT catalog/v1/types/businessmetadatadefs
schema-registry.DeleteBusinessMetadataDef	A request to delete a business metadata definition identified by its name. DELETE catalog/v1/types/businessmetadatadefs/(string: bmName)
schema-registry.UpdateSchemaTags	A request to bulk-update multiple tags. PUT catalog/v1/entity/tags

Schema Linking exporters authorization

The following authorization actions, or operations, on Confluent Cloud exporters generate auditable event messages for the io.confluent.sg.server/authorization event type.

Each of the following auditable event methods is generated by a request to the exporters API. Each method listed includes the action triggering an auditable event message and the associated exporters API request.

Method name	Action triggering an auditable event message
schema-registry.CreateExporter	A request to create a schema exporter. POST /exporters
schema-registry.UpdateExporter	A request to update schema exporter by name. PUT /exporters/(string: name)
schema-registry.UpdateExporterConfig	A request to update schema exporter configuration by name. PUT /exporters/(string: name)/config
schema-registry.PauseExporter	A request to pause schema exporter by name. PUT /exporters/(string: name)/pause
schema-registry.ResetExporter	A request to reset schema exporter by name. PUT /exporters/(string: name)/reset
schema-registry.ResumeExporter	A request to resume schema exporter by name. PUT /exporters/(string: name)/resume
schema-registry.DeleteExporter	A request to delete schema exporter by name. DELETE /exporters/(string: name)

Data encryption key authorization

The following authorization actions, or operations, on data encryption keys (DEK) and key encryption keys (KEK) generate auditable event messages for the io.confluent.sg.server/authorization event type.

Each of the following auditable event methods is generated by a request to the Confluent Cloud Schema Registry DEK API. Each method listed includes the action triggering an auditable event message for the io.confluent.sg.server/authorization event type.

Method name	Action triggering an auditable event message
schema-registry.RegisterKek	A request to register a key encryption key.
schema-registry.UpdateKek	A request to update a key encryption key.
schema-registry.DeregisterKek	A request to deregister a key encryption key.
schema-registry.RegisterDek	A request to register a data encryption key.
schema-registry.GetDek	A request to retrieve a data encryption key.
schema-registry.DeregisterDek	A request to deregister a data encryption key.