Service Endpoints Auditable Event Methods on Confluent Cloud

Auditable event methods for service endpoints include the actions, or operations, on Confluent Cloud endpoint discovery that generate auditable event messages.

Service endpoints provide fully qualified domain names (FQDNs) for connecting to Confluent Cloud resources such as Apache Kafka® clusters, Schema Registry, and Flink. The endpoint service supports discovery of both public and private endpoints across various connection types including public internet, PrivateLink, VPC peering, and Transit Gateway.

Expand all examples | Collapse all examples

Service endpoints auditable event methods

The following actions, or operations, on Confluent Cloud service endpoints generate auditable event messages.

Method name

Action triggering an audit log event message

ListEndpoints

A request to list service endpoints for Confluent Cloud resources.

ListEndpoints

The ListEndpoints event is generated by a request to list service endpoints for Confluent Cloud resources. This operation returns endpoint information for Kafka clusters, Schema Registry, or Flink based on the specified filters.

Examples

SUCCESS
{
   "datacontenttype": "application/json",
   "data": {
      "serviceName": "crn://confluent.cloud/",
      "methodName": "ListEndpoints",
      "cloudResources": [
         {
            "scope": {
               "resources": [
                  {
                     "type": "ORGANIZATION",
                     "resourceId": "94b47aa0-ed3a-44da-9460-6cec0c710e84"
                  }
               ]
            },
            "resource": {
               "type": "ENVIRONMENT",
               "resourceId": "env-abc123"
            }
         }
      ],
      "authenticationInfo": {
         "principal": {
            "email": "someone@example.com",
            "confluentUser": {
               "resourceId": "u-abc123"
            }
         },
         "result": "SUCCESS",
         "identity": "crn://confluent.cloud/organization=94b47aa0-ed3a-44da-9460-6cec0c710e84/identity-provider=Confluent/identity=u-abc123"
      },
      "requestMetadata": {
         "requestId": [
            "1085d1cbbb13ca134fe988824212ce26"
         ],
         "clientAddress": [
            {
               "ip": "1.2.3.4"
            }
         ]
      },
      "request": {
         "accessType": "READ_ONLY",
         "data": {
            "environment_id": "env-abc123",
            "service": "KAFKA"
         }
      },
      "result": {
         "status": "SUCCESS",
         "data": {
            "endpoint_count": 3
         }
      }
   }
}
SUCCESS - With resource ID filter
{
   "datacontenttype": "application/json",
   "data": {
      "serviceName": "crn://confluent.cloud/",
      "methodName": "ListEndpoints",
      "cloudResources": [
         {
            "scope": {
               "resources": [
                  {
                     "type": "ORGANIZATION",
                     "resourceId": "94b47aa0-ed3a-44da-9460-6cec0c710e84"
                  },
                  {
                     "type": "ENVIRONMENT",
                     "resourceId": "env-abc123"
                  }
               ]
            },
            "resource": {
               "type": "KAFKA_CLUSTER",
               "resourceId": "lkc-xyz789"
            }
         }
      ],
      "authenticationInfo": {
         "principal": {
            "email": "someone@example.com",
            "confluentUser": {
               "resourceId": "u-abc123"
            }
         },
         "result": "SUCCESS",
         "identity": "crn://confluent.cloud/organization=94b47aa0-ed3a-44da-9460-6cec0c710e84/identity-provider=Confluent/identity=u-abc123"
      },
      "requestMetadata": {
         "requestId": [
            "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
         ],
         "clientAddress": [
            {
               "ip": "1.2.3.4"
            }
         ]
      },
      "request": {
         "accessType": "READ_ONLY",
         "data": {
            "environment_id": "env-abc123",
            "service": "KAFKA",
            "resource_id": "lkc-xyz789"
         }
      },
      "result": {
         "status": "SUCCESS",
         "data": {
            "endpoint_count": 2
         }
      }
   }
}
SUCCESS - With Gateway and Access Point filters
{
   "datacontenttype": "application/json",
   "data": {
      "serviceName": "crn://confluent.cloud/",
      "methodName": "ListEndpoints",
      "cloudResources": [
         {
            "scope": {
               "resources": [
                  {
                     "type": "ORGANIZATION",
                     "resourceId": "94b47aa0-ed3a-44da-9460-6cec0c710e84"
                  },
                  {
                     "type": "ENVIRONMENT",
                     "resourceId": "env-abc123"
                  },
                  {
                     "type": "GATEWAY",
                     "resourceId": "gw-def456"
                  }
               ]
            },
            "resource": {
               "type": "ACCESS_POINT",
               "resourceId": "ap-ghi789"
            }
         }
      ],
      "authenticationInfo": {
         "principal": {
            "email": "someone@example.com",
            "confluentUser": {
               "resourceId": "u-abc123"
            }
         },
         "result": "SUCCESS",
         "identity": "crn://confluent.cloud/organization=94b47aa0-ed3a-44da-9460-6cec0c710e84/identity-provider=Confluent/identity=u-abc123"
      },
      "requestMetadata": {
         "requestId": [
            "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
         ],
         "clientAddress": [
            {
               "ip": "1.2.3.4"
            }
         ]
      },
      "request": {
         "accessType": "READ_ONLY",
         "data": {
            "environment_id": "env-abc123",
            "service": "KAFKA",
            "gateway_id": "gw-def456",
            "accesspoint_id": "ap-ghi789"
         }
      },
      "result": {
         "status": "SUCCESS",
         "data": {
            "endpoint_count": 1
         }
      }
   }
}
SUCCESS - Schema Registry endpoints
{
   "datacontenttype": "application/json",
   "data": {
      "serviceName": "crn://confluent.cloud/",
      "methodName": "ListEndpoints",
      "cloudResources": [
         {
            "scope": {
               "resources": [
                  {
                     "type": "ORGANIZATION",
                     "resourceId": "94b47aa0-ed3a-44da-9460-6cec0c710e84"
                  },
                  {
                     "type": "ENVIRONMENT",
                     "resourceId": "env-abc123"
                  }
               ]
            },
            "resource": {
               "type": "SCHEMA_REGISTRY",
               "resourceId": "lsrc-abc123"
            }
         }
      ],
      "authenticationInfo": {
         "principal": {
            "email": "someone@example.com",
            "confluentUser": {
               "resourceId": "u-abc123"
            }
         },
         "result": "SUCCESS",
         "identity": "crn://confluent.cloud/organization=94b47aa0-ed3a-44da-9460-6cec0c710e84/identity-provider=Confluent/identity=u-abc123"
      },
      "requestMetadata": {
         "requestId": [
            "c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8"
         ],
         "clientAddress": [
            {
               "ip": "1.2.3.4"
            }
         ]
      },
      "request": {
         "accessType": "READ_ONLY",
         "data": {
            "environment_id": "env-abc123",
            "service": "SCHEMA_REGISTRY",
            "resource_id": "lsrc-abc123"
         }
      },
      "result": {
         "status": "SUCCESS",
         "data": {
            "endpoint_count": 2
         }
      }
   }
}
FAILURE - Internal error
{
   "datacontenttype": "application/json",
   "data": {
      "serviceName": "crn://confluent.cloud/",
      "methodName": "ListEndpoints",
      "cloudResources": [
         {
            "scope": {
               "resources": [
                  {
                     "type": "ORGANIZATION",
                     "resourceId": "94b47aa0-ed3a-44da-9460-6cec0c710e84"
                  }
               ]
            },
            "resource": {
               "type": "ENVIRONMENT",
               "resourceId": "env-abc123"
            }
         }
      ],
      "authenticationInfo": {
         "principal": {
            "email": "someone@example.com",
            "confluentUser": {
               "resourceId": "u-abc123"
            }
         },
         "result": "SUCCESS",
         "identity": "crn://confluent.cloud/organization=94b47aa0-ed3a-44da-9460-6cec0c710e84/identity-provider=Confluent/identity=u-abc123"
      },
      "requestMetadata": {
         "requestId": [
            "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9"
         ],
         "clientAddress": [
            {
               "ip": "1.2.3.4"
            }
         ]
      },
      "request": {
         "accessType": "READ_ONLY",
         "data": {
            "environment_id": "env-abc123",
            "service": "KAFKA"
         }
      },
      "result": {
         "status": "FAILURE",
         "data": {
            "errors": [
               {
                  "id": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
                  "status": "500",
                  "detail": "Internal error occurred while retrieving endpoints.",
                  "source": {}
               }
            ]
         }
      }
   }
}