Organization Auditable Event Methods¶
Expand all examples | Collapse all examples
Organization auditable events occur across many Confluent Cloud resources in a Confluent Cloud organization, including actions and operations on:
- Billing
- MarketPlace Entitlement
- Notification Service
- API key
- Service account
- User account
- Invitation
- Sign-in attempt
- Single Sign-on (SSO) connection
- Identity provider
- IP filter
- Environment
- Schema Registry cluster
- Kafka cluster
- Connector
- Custom connector plugin
- ksqlDB cluster
- Network
- Peering connection
- Private link access
- Transit gateway attachment
- Pipeline (for Stream Designer)
- Flink
Billing¶
Included here are the actions, or operations, on billing-related information that generate auditable event messages.
For more about billing, see Manage Billing in Confluent Cloud.
| Method name | Action triggering an auditable event message |
|---|---|
| ClaimPromoCode | A request to claim a promotion code for the organization. |
| UpdateBillingProfile | A request to update the billing-related information, such as billing email address. |
| UpdatePaymentMethod | A request to update the payment method. |
| UpdateSupportPlan | A request to update the support plan. |
| UpdateTaxInfo | A request to update tax info once payment method has been changed. |
ClaimPromoCode¶
The ClaimPromoCode event is generated by a request to claim a promotion code.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"ClaimPromoCode",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"e702dd15-ef01-412f-8460-33c94404b582"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-dog38d"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"67f36a9c3e9a228b7e45ff5d7218a8e9"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"code":"TEST1234"
}
},
"result":{
"status":"SUCCESS",
"data":{
"amount":50,
"claim":{
"claimed_at":"2022-01-22T05:01:41.490153Z",
"expires_at":"2022-01-29T05:01:41Z"
},
"code":"TEST1234"
}
}
},
"subject":"crn://confluent.cloud/organization=e702dd15-ef01-412f-8460-33c94404b582",
"specversion":"1.0",
"id":"441a4cb2-5db4-4abf-85db-fada577ad120",
"source":"crn://confluent.cloud/",
"time":"2022-01-22T05:01:41.494Z",
"type":"io.confluent.cloud/request"
}
UpdateBillingProfile¶
The UpdateBillingProfile event is generated by a request to update a billing profile.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateBillingProfile",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"e702dd15-ef01-412f-8460-33c94404b582"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-dog38d"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"cbaa9956af7cfcddbcc4d56a3e5686e2"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"email":"someone@example.com"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=e702dd15-ef01-412f-8460-33c94404b582",
"specversion":"1.0",
"id":"f99fb21a-7b9e-4900-adfa-d731530559ba",
"source":"crn://confluent.cloud/",
"time":"2022-01-22T05:00:41.439Z",
"type":"io.confluent.cloud/request"
}
UpdatePaymentMethod¶
The UpdatePaymentMethod event is generated by a request to update the details of a payment method.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdatePaymentMethod",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"e702dd15-ef01-412f-8460-33c94404b582"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-dog38d"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"31ac59902f79c0406b64cc8a3d71e092"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION"
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=e702dd15-ef01-412f-8460-33c94404b582",
"specversion":"1.0",
"id":"25042f4c-130d-427a-a0ff-28c280111cf5",
"source":"crn://confluent.cloud/",
"time":"2022-01-22T05:00:31.595Z",
"type":"io.confluent.cloud/request"
}
UpdateSupportPlan¶
The UpdateSupportPlan event is generated by a request to update the details of a support plan.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateSupportPlan",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"e702dd15-ef01-412f-8460-33c94404b582"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-dog38d"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"feb55780d84f9cf45720331fd4c118ed"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"subscription_type":"DEVELOPER"
}
},
"result":{
"status":"SUCCESS",
"data":{
"effective_at":"2022-02-01T00:00:00Z",
"subscription_type":"DEVELOPER"
}
}
},
"subject":"crn://confluent.cloud/organization=e702dd15-ef01-412f-8460-33c94404b582",
"specversion":"1.0",
"id":"2ddccfc7-0657-472b-a495-46ef8b2ccfcd",
"source":"crn://confluent.cloud/",
"time":"2022-01-22T04:59:46.765Z",
"type":"io.confluent.cloud/request"
}
UpdateTaxInfo¶
The UpdateTaxInfo event is generated by a request to update the tax information details.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateTaxInfo",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"e702dd15-ef01-412f-8460-33c94404b582"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-dog38d"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"b0fd0fbacd72431256dd1bb1771c7f15"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"tax":{
"country":"US",
"line_1":"112 BOISE DR",
"line_2":"",
"postal_code":"95008",
"state":"CA",
"tax_ids":[
{
"type":"",
"identifier":""
}
],
"city":"CAMPBELL"
}
}
},
"result":{
"status":"SUCCESS",
"data":{
"tax":{
"country":"US",
"line_1":"112 BOISE DR",
"line_2":"",
"postal_code":"95008",
"state":"CA",
"tax_ids":[
{
"identifier":"",
"type":""
}
],
"city":"CAMPBELL"
}
}
}
},
"subject":"crn://confluent.cloud/organization=e702dd15-ef01-412f-8460-33c94404b582",
"specversion":"1.0",
"id":"4d45ea58-a6a4-455f-925b-d90cfadf6ceb",
"source":"crn://confluent.cloud/",
"time":"2022-01-22T05:00:32.169Z",
"type":"io.confluent.cloud/request"
}
Marketplace Entitlement¶
Included here are the actions, or operations, on a Confluent Cloud marketplace entitlement that generate auditable event messages.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateMarketplaceEntitlement | A request to create a marketplace entitlement. |
| UpdateMarketplaceEntitlement | A request to update an existing marketplace entitlement. Generated when editing, deactivating, or reactivating the entitlement. |
CreateMarketplaceEntitlement¶
The CreateMarketEntitlement event is generated by a request to create a marketplace entitlement.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateMarketplaceEntitlement",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"bf1050ca-0395-4b81-afb9-2fa5b1161814"
}
]
},
"resource":{
"type":"MARKETPLACE_ENTITLEMENT",
"resourceId":"30bc9fb2-2ae4-4854-9403-87eaed4db21a"
}
}
],
"authenticationInfo":{
"principal":{
"externalAccount":{
"namespace":[
{
"type":"idp",
"id":"confluent.cloud"
},
{
"type":"scope",
"id":"service"
}
],
"subject":"cc-marketplace-service"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"948c494953789674c1287f2c6b5f12ec"
],
"clientAddress":[
{
"ip":"1.2.3.4",
"internal":true
}
],
"requestType":"GRPC"
},
"request":{
"accessType":"MODIFICATION",
"data":{
"external_id":"30bc9fb2-2ae4-4854-9403-87eaed4db21a",
"created":"2022-03-29T06:03:34.736141Z",
"modified":"2022-03-29T06:03:38.170284Z"
}
},
"result":{
"status":"SUCCESS",
"data":{
"external_id":"30bc9fb2-2ae4-4854-9403-87eaed4db21a",
"created":"2022-03-29T06:03:34.736141Z",
"modified":"2022-03-29T06:24:48.650062Z"
}
}
},
"subject":"crn://confluent.cloud/organization=bf1050ca-0395-4b81-afb9-2fa5b1161814/marketplace-entitlement=30bc9fb2-2ae4-4854-9403-87eaed4db21a",
"specversion":"1.0",
"id":"af7ac237-6339-4a36-8ff1-be2259014967",
"source":"crn://confluent.cloud/",
"time":"2022-03-29T06:24:48.654Z",
"type":"io.confluent.cloud/request"
}
UpdateMarketplaceEntitlement¶
The UpdateMarketplaceEntitlement event is generated by a request to update
an existing marketplace entitlement. This event is generated when editing,
deactivating, or reactivating the entitlement.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateMarketplaceEntitlement",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "900084ca-9571-4b3d-ac56-0717d30659e9"
}
]
},
"resource": {
"type": "MARKETPLACE_ENTITLEMENT",
"resourceId": "30bc9fb2-2ae4-4854-9403-87eaed4db21a"
}
}
],
"authenticationInfo": {
"principal": {
"externalAccount": {
"namespace": [
{
"type": "idp",
"id": "confluent.cloud"
},
{
"type": "scope",
"id": "service"
}
],
"subject": "cc-marketplace-service"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"10c777e03f830e6095b2e82f57a4b837"
],
"clientAddress": [
{
"ip": "1.2.3.4",
"internal": true
}
],
"requestType": "GRPC"
},
"request": {
"accessType": "MODIFICATION",
"data": {
"created": "2022-03-29T06:00:29.808762620Z",
"modified": "2022-03-29T06:00:29.808762620Z",
"external_id": "30bc9fb2-2ae4-4854-9403-87eaed4db21a"
}
},
"result": {
"status": "SUCCESS",
"data": {
"modified": "2022-03-29T06:00:29.808762620Z",
"external_id": "30bc9fb2-2ae4-4854-9403-87eaed4db21a",
"created": "2022-03-29T06:00:29.808762620Z"
}
}
},
"subject": "crn://confluent.cloud/organization=900084ca-9571-4b3d-ac56-0717d30659e9/marketplace-entitlement=30bc9fb2-2ae4-4854-9403-87eaed4db21a",
"specversion": "1.0",
"id": "bacaa4ab-5b36-44e4-a26d-7e73fb035d02",
"source": "crn://confluent.cloud/",
"time": "2022-03-29T06:00:29.813Z",
"type": "io.confluent.cloud/request"
}
API key¶
Here are the actions, or operations, on an API key that generate auditable event messages. For more about API keys, see Use API Keys to Control Access in Confluent Cloud.
| Method name | Action triggering an audit log event message |
|---|---|
| CreateAPIKey | A request to create an API key. Can be a Cloud API key or resource-specific API key (for Kafka cluster, ksqlDB, or Schema Registry). |
| DeleteAPIKey | A request to delete an API key. |
| GetAPIKey | (v2 only) A request to get the details of an API key. |
| GetAPIKeys | A request to get a list of the API keys. |
| UpdateAPIKey | A request to update an API key. |
CreateAPIKey¶
The CreateAPIKey is generated by a request to create an API key.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"CreateAPIKey",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
},
{
"type":"USER",
"resourceId":"u-4nqg6k"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"ZS3QFNAWIJDXCJ5G"
}
},
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"ZS3QFNAWIJDXCJ5G"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"ed6b3e35f8cb760bf8bc3b540f85bf11"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"spec":{
"description":"some API key",
"display_name":"My first cloud key",
"owner":{
"id":"u-4nqg6k",
"related":"https://api.confluent.cloud/iam/v2/users/u-4nqg6k",
"resource_name":""
}
}
}
},
"result":{
"status":"SUCCESS",
"data":{
"api_version":"iam/v2",
"id":"ZS3QFNAWIJDXCJ5G",
"kind":"ApiKey",
"metadata":{
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k/api-key=ZS3QFNAWIJDXCJ5G",
"self":"http://api.confluent.cloud/iam/v2/api-keys/ZS3QFNAWIJDXCJ5G",
"updated_at":"2022-03-15T17:00:08.969032Z",
"created_at":"2022-03-15T17:00:08.969032Z",
"deleted_at":"0001-01-01T00:00:00Z"
},
"spec":{
"secret":"**************",
"description":"some API key",
"display_name":"My first cloud key",
"owner":{
"kind":"User",
"related":"https://api.confluent.cloud/iam/v2/users/u-4nqg6k",
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k",
"api_version":"iam/v2",
"id":"u-4nqg6k"
},
"resource":{
"related":"cloud",
"resource_name":"cloud",
"api_version":"iam/v2",
"id":"cloud",
"kind":"Cloud"
}
}
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"16d2467a-16ec-4571-939c-6a881ae28965",
"source":"crn://confluent.cloud/",
"time":"2022-03-15T17:00:08.980Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("service name is already in use")
You can create a service account name by using the Confluent CLI
confluent iam service-account create command. The service account
name cannot be changed after creation.
FAILURE ("Your Api Keys per User is currently limited to 10")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"CreateAPIKey",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"b200775984c15e3389ad823118ffa61a"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"spec":{
"resource":{
"id":"lkc-abc",
"related":"https://api.confluent.cloud/cmk/iam/v2/clusters/lkc-abc",
"resource_name":"crn://confluent.cloud/organization=123/environment=env-xyz/cloud-cluster=lkc-abc/kafka=lkc-abc"
},
"description":"some API key",
"display_name":"My new key",
"owner":{
"id":"u-4nqg6k",
"related":"https://api.confluent.cloud/iam/v2/users/u-4nqg6k",
"resource_name":""
}
}
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"b200775984c15e3389ad823118ffa61a",
"status":"402",
"code":"quota_exceeded",
"detail":"Your Api Keys per User is currently limited to 10",
"source":{
}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"50b33023-a96e-4682-b92a-588659091771",
"source":"crn://confluent.cloud/",
"time":"2022-03-16T02:51:49.822Z",
"type":"io.confluent.cloud/request"
}
DeleteAPIKey¶
The DeleteAPIKey event is generated by a request to delete an API key.
Examples¶
FAILURE ("internal service account deletion not allowed")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"DeleteAPIKey",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
},
{
"type":"USER",
"resourceId":"u-4nqg6k"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
},
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"1bd0ef4fca435097946a960cef62c2b3"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"GPMSWXMFCCD431HX"
}
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"6a5419b0-8d7a-4230-aa1f-976309e401c1",
"source":"crn://confluent.cloud/",
"time":"2022-03-15T19:17:23.675Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Forbidden access")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"DeleteAPIKey",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"efb977ea28551426798151ab8beca709"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"GPMRWXLFCCD332GX"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"detail":"Forbidden Access",
"source":{
},
"id":"efb977ea28551426798151ab8beca709",
"status":"403",
"code":"forbidden_access"
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"4bbc8df3-e41b-4f86-beae-5f8651995199",
"source":"crn://confluent.cloud/",
"time":"2022-03-16T00:33:36.396Z",
"type":"io.confluent.cloud/request"
}
GetAPIKey¶
The GetAPIKey event is generated by a request to get the details of an API key.
Examples¶
FAILURE ("Fail to create sso connection ...")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetAPIKey",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
},
{
"type":"USER",
"resourceId":"u-4nqg6k"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
},
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"b580ba2cddfd670e3959a3a2505ce3fa"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"GPMRWXLFCCD332GX"
}
},
"result":{
"status":"SUCCESS",
"data":{
"api_version":"iam/v2",
"id":"GPMRWXLFCCD332GX",
"kind":"ApiKey",
"metadata":{
"deleted_at":"0001-01-01T00:00:00Z",
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k/api-key=GPMRWXLFCCD332GX",
"self":"http://api.confluent.cloud/iam/v2/api-keys/GPMRWXLFCCD332GX",
"updated_at":"2022-03-15T19:03:34.224964Z",
"created_at":"2022-03-15T18:20:52.271938Z"
},
"spec":{
"description":"some API key",
"display_name":"My first cloud key",
"owner":{
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k",
"api_version":"iam/v2",
"id":"u-4nqg6k",
"kind":"User",
"related":"http://api.confluent.cloud/iam/v2/users/u-4nqg6k"
},
"resource":{
"api_version":"iam/v2",
"id":"cloud",
"kind":"Cloud",
"related":"cloud",
"resource_name":"cloud"
},
"secret":""
}
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"dc5f90f7-0e3a-40a1-b05d-cecaad54f3d4",
"source":"crn://confluent.cloud/",
"time":"2022-03-15T19:11:05.013Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Forbidden Access")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetAPIKey",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"8963db44957773a1589d3dda039a563b"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"GPMRWXLFCCD332GX"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"8963db44957773a1589d3dda039a563b",
"status":"403",
"code":"forbidden_access",
"detail":"Forbidden Access",
"source":{
}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"249f2f5b-625a-4fe6-9608-586c4ee6cb06",
"source":"crn://confluent.cloud/",
"time":"2022-03-16T00:38:43.624Z",
"type":"io.confluent.cloud/request"
}
GetAPIKeys¶
The GetAPIKeys event is generated by a request to get a list of the API keys in the organization.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetAPIKeys",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"8996286ae1b48dd2532f58b8ab135e21"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"owner":{
"related":"",
"resource_name":"",
"id":""
},
"resource":{
"id":"",
"related":"",
"resource_name":""
},
"page_size":20.0
}
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=1181fcf4-3d17-4994-af6b-bfefda71ac2f"
},
"subject":"crn://confluent.cloud/organization=1181fcf4-3d17-4994-af6b-bfefda71ac2f",
"specversion":"1.0",
"id":"36c8de4a-22c5-48d2-9815-b810ebb3b482",
"source":"crn://confluent.cloud/",
"time":"2022-03-15T16:37:22.320Z",
"type":"io.confluent.cloud/request"
}
UpdateAPIKey¶
The UpdateAPIKey event is generated by a request to update the details of an API key.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateAPIKey",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
},
{
"type":"USER",
"resourceId":"u-4nqg6k"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
},
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
]
},
"resource":{
"type":"API_KEY",
"resourceId":"GPMRWXLFCCD332GX"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"d73ca5acc994cb723bb242f314011e9f"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"spec":{
"description":"some API key",
"display_name":"My first cloud key"
}
}
},
"result":{
"status":"SUCCESS",
"data":{
"api_version":"iam/v2",
"id":"GPMRWXLFCCD332GX",
"kind":"ApiKey",
"metadata":{
"deleted_at":"0001-01-01T00:00:00Z",
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k/api-key=GPMRWXLFCCD332GX",
"self":"http://api.confluent.cloud/iam/v2/api-keys/GPMRWXLFCCD332GX",
"updated_at":"2022-03-15T19:03:34.224964Z",
"created_at":"2022-03-15T18:20:52.271938Z"
},
"spec":{
"description":"some API key",
"display_name":"My first cloud key",
"owner":{
"api_version":"iam/v2",
"id":"u-4nqg6k",
"kind":"User",
"related":"http://api.confluent.cloud/iam/v2/users/u-4nqg6k",
"resource_name":"crn://api.confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934/user=u-4nqg6k"
},
"resource":{
"kind":"Cloud",
"related":"cloud",
"resource_name":"cloud",
"api_version":"iam/v2",
"id":"cloud"
},
"secret":""
}
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"4e69c84a-fa3f-43b6-accb-1587f1c6b982",
"source":"crn://confluent.cloud/",
"time":"2022-03-15T19:03:34.236Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Forbidden Access")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateAPIKey",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"f909d203-5570-4cc3-9a15-712016536934"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-4nqg6k"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"9cfb4ceb9565deba841ee9393ded4c2c"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"spec":{
"description":"some updated description",
"display_name":"My new diplay name"
}
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"9cfb4ceb9565deba841ee9393ded4c2c",
"status":"403",
"code":"forbidden_access",
"detail":"Forbidden Access",
"source":{
}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
},
"subject":"crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
"specversion":"1.0",
"id":"e0f93b12-e641-4677-a789-3963ee16dea8",
"source":"crn://confluent.cloud/",
"time":"2022-03-16T00:43:59.376Z",
"type":"io.confluent.cloud/request"
}
Service account¶
Included here are the actions, or operations, on a Confluent Cloud service account that generate auditable event messages. For more about service accounts, see Service Accounts for Confluent Cloud.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateServiceAccount | A request to create a service account. |
| DeleteServiceAccount | A request to delete a service account. |
| GetServiceAccount | A request to get the details of a service account. |
| GetServiceAccounts | A request to get a list of service accounts in the organization. |
| UpdateServiceAccount | A request to get a list of service accounts in the organization. |
CreateServiceAccount¶
The CreateServiceAccount event is generated by a request to create a service account.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "29845f30-4143-4ba8-88a7-af4b58f06dd6",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=51efe7da-620f-46e8-b4f4-2870778b8130/service-account=sa-xmw51x",
"time": "2021-10-20T23:34:01.452240027Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateServiceAccount",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "51efe7da-620f-46e8-b4f4-2870778b8130"
}
]
},
"resource": {
"type": "SERVICE_ACCOUNT",
"resourceId": "sa-xmw51x"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-zm610y"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"87de0d537df60407a3f93b690be85a89"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"description": "Service Account Test",
"display_name": "TestAccount",
"kind": "ServiceAccount"
}
},
"result": {
"status": "SUCCESS",
"data": {
"description": "Service Account Test",
"display_name": "TestAccount",
"id": "sa-xmw51x",
"kind": "ServiceAccount",
"metadata": {
"created_at": "2021-10-20T23:34:01.359198Z",
"resource_name": "crn://confluent.cloud/service-account=sa-xmw51x",
"self": "https://api.confluent.cloud/v2/service-accounts/sa-xmw51x",
"updated_at": "2021-10-20T23:34:01.359198Z"
},
"api_version": "v2"
}
},
"resourceName": "crn://confluent.cloud/organization=51efe7da-620f-46e8-b4f4-2870778b8130/service-account=sa-xmw51x"
}
}
FAILURE ("service name is already in use")
You can create a service account name by using the Confluent CLI
confluent iam service-account create command. The service account
name cannot be changed after creation.
To see a list of existing service account names, use the Confluent CLI
confluent iam service-account list command.
{
"specversion": "1.0",
"id": "a482c7c6-d574-4a51-ad08-5b6b125d043c",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=b43254ac-acd3-404b-af13-f236f6cd3b42",
"time": "2021-10-20T23:33:38.414041393Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateServiceAccount",
"cloudResources": [
{
"resource": {
"type": "ORGANIZATION",
"resourceId": "b43254ac-acd3-404b-af13-f236f6cd3b42"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-em5roq"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"6ad347454cb5cf6e0f33b4ab70604de8"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"description": "Service Account Test",
"display_name": "TestAccount",
"kind": "ServiceAccount"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"detail": "Service name is already in use.",
"source": {},
"id": "6ad347454cb5cf6e0f33b4ab70604de8",
"status": "409"
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=b43254ac-acd3-404b-af13-f236f6cd3b42"
}
}
DeleteServiceAccount¶
The DeleteServiceAccount event is generated by a request to delete a service account.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "d2bf64d7-8f1e-4382-92bf-f1c7e910b037",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=51efe7da-620f-46e8-b4f4-2870778b8130/service-account=sa-knoowp",
"time": "2021-10-21T09:34:07.586373367Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteServiceAccount",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "51efe7da-620f-46e8-b4f4-2870778b8130"
}
]
},
"resource": {
"type": "SERVICE_ACCOUNT",
"resourceId": "sa-knoowp"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-zm610y"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"23599bff64644cb169433beed0f795cf"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"id": "sa-knoowp",
"kind": "ServiceAccount"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=51efe7da-620f-46e8-b4f4-2870778b8130/service-account=sa-knoowp"
}
}
FAILURE ("internal service account deletion not allowed")
{
"specversion": "1.0",
"id": "3c676586-ac30-4f22-962c-5f7887658ca9",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=03ec7412-664a-422e-98f5-4967df5c534a/service-account=sa-8w6dk0",
"time": "2021-10-21T03:12:54.385414467Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteServiceAccount",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "03ec7412-664a-422e-98f5-4967df5c534a"
}
]
},
"resource": {
"type": "SERVICE_ACCOUNT",
"resourceId": "sa-8w6dk0"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-gn35j3"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"c9607f637d162167170b31ef92864c73"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"kind": "ServiceAccount",
"api_version": "v2",
"id": "sa-8w6dk0"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"status": "403",
"detail": "internal service account deletion not allowed",
"source": {},
"id": "c9607f637d162167170b31ef92864c73"
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=03ec7412-664a-422e-98f5-4967df5c534a/service-account=sa-8w6dk0"
}
}
GetServiceAccount¶
The GetServiceAccount event is generated by a request to get the details of a service account.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetServiceAccount",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"SERVICE_ACCOUNT",
"resourceId":"sa-r2rm2p"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"586726d414dc1904b0b190c11f708e21"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"sa-r2rm2p"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/service-account=sa-r2rm2p",
"specversion":"1.0",
"id":"02f72927-7f1a-4bdd-88d9-2bcf494603b5",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:16:22.288Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Service Account Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetServiceAccount",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"6f98c722b10406fc1d2ef73af63c83e7"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"sa-r2rm2"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"detail":"Service Account Not Found",
"source":{
},
"id":"6f98c722b10406fc1d2ef73af63c83e7",
"status":"404",
"code":"service_account_not_found"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"431c3b65-7e00-4375-aeb6-1b5f78d66ddd",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:16:36.340Z",
"type":"io.confluent.cloud/request"
}
GetServiceAccounts¶
The GetServiceAccounts event is generated by a request to get a list of
service accounts in the organization.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetServiceAccounts",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"74fcab57cf239412e271ff3c1cdc42cd"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY"
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"98ec3428-988c-444c-9bce-f5dac58c3fad",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:17:18.243Z",
"type":"io.confluent.cloud/request"
}
UpdateServiceAccount¶
The UpdateServiceAccount event is generated by a request to update the
details of a service account.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetServiceAccount",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"SERVICE_ACCOUNT",
"resourceId":"sa-r2rm2p"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"586726d414dc1904b0b190c11f708e21"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"sa-r2rm2p"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/service-account=sa-r2rm2p",
"specversion":"1.0",
"id":"02f72927-7f1a-4bdd-88d9-2bcf494603b5",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:16:22.288Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Service Account Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetServiceAccount",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"6f98c722b10406fc1d2ef73af63c83e7"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"sa-r2rm2"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"detail":"Service Account Not Found",
"source":{
},
"id":"6f98c722b10406fc1d2ef73af63c83e7",
"status":"404",
"code":"service_account_not_found"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"431c3b65-7e00-4375-aeb6-1b5f78d66ddd",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:16:36.340Z",
"type":"io.confluent.cloud/request"
}
User account¶
Included here are the actions, or operations, on a user account that generate auditable event messages. For more about user accounts, see User account types.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateUser | A request to create a user account. |
| DeleteUser | A request to delete a user account. |
| GetUser | A request to get the details of a user account. |
| GetUsers | A request to get a list of user accounts in the organization. |
| InviteUser | A request to invite a user. |
| UpdateUser | A request to update a user account. |
CreateUser¶
The CreateUser event is generated by a request to create a user account.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "fe5d1cf6-cb90-4619-927f-ae6445ead5b6",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=a0b5e129-4d9a-4ab2-9228-a77ad26e5b97/user=u-xmwwyz",
"time": "2021-10-21T09:09:35.016074411Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateUser",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "a0b5e129-4d9a-4ab2-9228-a77ad26e5b97"
}
]
},
"resource": {
"type": "USER",
"resourceId": "u-xmwwyz"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-loy67j"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"1567fdc76e352ce41c1f3b5fc6a748a1"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"email": "someone@example.com",
"family_name": "",
"given_name": "",
"kind": "User"
}
},
"result": {
"status": "SUCCESS",
"data": {
"metadata": {
"created_at": "2021-10-21T09:09:34.415505Z",
"resource_name": "crn://confluent.cloud/user=u-xmwwyz",
"self": "https://api.confluent.cloud/v2/users/u-xmwwyz",
"updated_at": "2021-10-21T09:09:34.415505Z"
},
"api_version": "v2",
"email": "someone@example.com",
"family_name": "",
"given_name": "",
"id": "u-xmwwyz",
"kind": "User"
}
},
"resourceName": "crn://confluent.cloud/organization=a0b5e129-4d9a-4ab2-9228-a77ad26e5b97/user=u-xmwwyz"
}
}
FAILURE ("Error while calling CreateUser")
Because the InviteUser method calls the CreateUser method,
an auditable event message is also generated for that event.
See example: InviteUser: Invite a user – failure (“Error while calling CreateUser”)
DeleteUser¶
The DeleteUser event is generated by a request to delete a user account.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "2407277a-ec55-45e2-b332-6e960c5466cb",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=a0b5e129-4d9a-4ab2-9228-a77ad26e5b97/user=u-3r60xj",
"time": "2021-10-20T23:09:29.974802315Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteUser",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "a0b5e129-4d9a-4ab2-9228-a77ad26e5b97"
}
]
},
"resource": {
"type": "USER",
"resourceId": "u-3r60xj"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-loy67j"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"ab84c249204068eb234d61dc56db8e3c"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"id": "u-3r60xj",
"kind": "User"
}
},
"result": {
"status": "SUCCESS",
"data": {
"metadata": {
"created_at": "2021-10-21T09:09:34.415505Z",
"resource_name": "crn://confluent.cloud/user=u-xmwwyz",
"self": "https://api.confluent.cloud/v2/users/u-xmwwyz",
"updated_at": "2021-10-21T09:09:34.415505Z"
},
"api_version": "v2",
"email": "someone@example.com",
"family_name": "",
"given_name": "",
"id": "u-xmwwyz",
"kind": "User"
}
},
"resourceName": "crn://confluent.cloud/organization=a0b5e129-4d9a-4ab2-9228-a77ad26e5b97/user=u-3r60xj"
}
}
FAILURE ("Forbidden")
{
"specversion": "1.0",
"id": "225878cb-8303-4a93-a889-5c830f076588",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=b5d32ee9-fbe6-4318-89c4-94ec38c04e09/user=u-5wdzk2",
"time": "2021-10-20T23:37:09.26224479Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteUser",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "b5d32ee9-fbe6-4318-89c4-94ec38c04e09"
}
]
},
"resource": {
"type": "USER",
"resourceId": "u-5wdzk2"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-zmp7wd"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"eec8ad83d0acd6d8bb68af912cd24ff1"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"kind": "User",
"api_version": "v2",
"id": "u-5wdzk2"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "eec8ad83d0acd6d8bb68af912cd24ff1",
"status": "403",
"code": "forbidden",
"detail": "Forbidden",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=b5d32ee9-fbe6-4318-89c4-94ec38c04e09/user=u-5wdzk2"
}
}
GetUser¶
The GetUser event is generated by a request to get the details of a user account.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetUser",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"USER",
"resourceId":"u-5721zz"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"927310d22c108d658b77c9d0005f9fd8"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"u-5721zz"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/user=u-5721zz",
"specversion":"1.0",
"id":"365f4dd4-c467-43f4-a41b-44d26420e9dd",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:08:22.388Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("User Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetUser",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"2e923460c880ab02158787fdad1c6959"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"u-sdfwe"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"status":"404",
"code":"user_not_found",
"detail":"User Not Found",
"source":{
},
"id":"2e923460c880ab02158787fdad1c6959"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"b95a31f9-aedc-4192-aae8-e1fcf43e1847",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:11:08.284Z",
"type":"io.confluent.cloud/request"
}
GetUsers¶
The GetUsers event is generated by a request to get the list of user
accounts in the organization.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetUsers",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"5be8ef8311ef1c49584ea07e457aeef6"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY"
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"c03dae63-4c59-4e0c-b93d-d7ca6c05af5f",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:12:02.098Z",
"type":"io.confluent.cloud/request"
}
InviteUser¶
The InviteUser event is generated by a request to invite a user.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "a6f46eaf-a6a9-4f70-8324-2de6c2284d9d",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/user-invitation=i-emkm7",
"time": "2021-10-20T19:35:20.713940551Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "InviteUser",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "906da5b6-ebac-44cf-8a8d-663559f1f0d4"
}
]
},
"resource": {
"type": "USER_INVITATION",
"resourceId": "i-emkm7"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-4xn71e"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"c8afbbcfa7ceefb2e6e066b005ea1822"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"kind": "UserInvitation",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/user-invitation=*",
"self": ""
},
"role_bindings": null,
"send_invitation": true,
"user": {
"api_version": "v2",
"email": "someone@example.com",
"kind": "User"
}
}
},
"result": {
"status": "SUCCESS",
"data": {
"user": {
"api_version": "v2",
"email": "someone@example.com",
"id": "u-1j60n5",
"kind": "User"
},
"api_version": "v2",
"kind": "UserInvitation",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/user-invitation=i-emkm7",
"self": ""
},
"send_invitation": true
}
},
"resourceName": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/user-invitation=i-emkm7"
}
}
FAILURE ("Error while calling CreateUser")
Because the InviteUser method calls the CreateUser method,
an auditable event message is also generated for that auditable event.
{
"specversion": "1.0",
"id": "b7028857-c86e-4f11-af29-e62abcdd0dfb",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3",
"time": "2021-10-25T02:16:34.361528304Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "InviteUser",
"cloudResources": [
{
"resource": {
"type": "ORGANIZATION",
"resourceId": "1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-l93dom"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"ae0adf7fbf9c4e659fb86f8cbf126666"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"kind": "UserInvitation",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/user-invitation=*",
"self": ""
},
"role_bindings": null,
"send_invitation": false,
"user": {
"api_version": "v2",
"email": "someone@example.com",
"kind": "User"
}
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"source": {},
"id": "ae0adf7fbf9c4e659fb86f8cbf126666",
"status": "500",
"detail": "Error while calling CreateUser: Error while calling CreateUser"
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
}
FAILURE ("Invitation already existed for the specific user")
{
"specversion": "1.0",
"id": "b2d82908-ce58-4d55-83e4-96b5d3143a20",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=54517031-7618-490a-87bc-f6db688980be",
"time": "2021-10-21T01:14:56.17990388Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "InviteUser",
"cloudResources": [
{
"resource": {
"type": "ORGANIZATION",
"resourceId": "54517031-7618-490a-87bc-f6db688980be"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-l6zq34"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"c7a113317b576614e14035f237d34a69"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"send_invitation": true,
"user": {
"api_version": "v2",
"email": "someone@example.com",
"kind": "User"
},
"api_version": "v2",
"kind": "UserInvitation",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=54517031-7618-490a-87bc-f6db688980be/user-invitation=*",
"self": ""
},
"role_bindings": null
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"source": {},
"id": "c7a113317b576614e14035f237d34a69",
"status": "409",
"detail": "Invitation already existed for the specific user."
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=54517031-7618-490a-87bc-f6db688980be"
}
}
UpdateUser¶
The UpdateUser event is generated by a request to update the details of a user account.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateUser",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"USER",
"resourceId":"u-5721zz"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"8c2bae56442c234b77c59102ccc4eb0e"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"email":"someone@example.com",
"full_name":"lucas_test liu",
"id":"",
"kind":"User",
"api_version":"iam/v2"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/user=u-5721zz",
"specversion":"1.0",
"id":"5c5ed5e0-7e7a-436f-8d16-6acf3f7c040f",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:08:28.972Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Forbidden Access")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateUser",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"5551ccd2a85131487ac934315a6b226a"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"kind":"User",
"api_version":"iam/v2",
"email":"",
"full_name":"",
"id":"u-sdfwe"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"detail":"Forbidden",
"source":{
},
"id":"5551ccd2a85131487ac934315a6b226a",
"status":"403",
"code":"forbidden"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"a0b3ee6d-dbd9-42f5-acf4-dfbb1f1a6cfe",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:10:20.979Z",
"type":"io.confluent.cloud/request"
}
Invitation¶
Included here are the actions, or operations, on a Confluent Cloud invitation that generate auditable event messages.
| Method name | Action triggering an auditable event message |
|---|---|
| DeleteInvitation | A request to delete an invitation. |
| GetInvitation | A request to get the details of an invitation. |
| GetInvitations | A request to get a list of invitations in the organization. |
| ResendInvitation | A request to resend an invitation. |
DeleteInvitation¶
The DeleteInvitation event is generated by a request to delete an invitation.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"DeleteInvitation",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"USER_INVITATION",
"resourceId":"i-xqjzq"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"c260bdfd9b4e5a125905d28d67dbeaac"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"i-xqjzq"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/user-invitation=i-xqjzq",
"specversion":"1.0",
"id":"a460a0ce-3953-4e1d-b617-ee685fe3a5d7",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:27:34.180Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Invitation Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"DeleteInvitation",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"9fe5af2cd3a0dc342e5f89c80a93457e"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"i-sdf"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"source":{
},
"id":"9fe5af2cd3a0dc342e5f89c80a93457e",
"status":"404",
"detail":"Invitation Not Found"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"addbfa55-895d-4e52-97bf-1995edbcf285",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:28:58.493Z",
"type":"io.confluent.cloud/request"
}
GetInvitation¶
The GetInvitation is generated by a request to get an invitation.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetInvitation",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"USER_INVITATION",
"resourceId":"i-xqjzq"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"3da8619b9992ac573e88d3b3c2c56336"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"i-xqjzq"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/user-invitation=i-xqjzq",
"specversion":"1.0",
"id":"1e78baa6-e443-495f-b367-9ed12e3e6850",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:21:15.918Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Invitation Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetInvitation",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"1d470be175766dd8dc9df28409f441e8"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"i-sdf"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"1d470be175766dd8dc9df28409f441e8",
"status":"404",
"detail":"Invitation Not Found",
"source":{
}
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"0fc6d515-b087-4932-ab2f-b3f36a0c52a0",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:21:54.257Z",
"type":"io.confluent.cloud/request"
}
GetInvitations¶
The GetInvitations event is generated by a request to get a list of invitations
in the organization.
Examples¶
FAILURE ("You already have 3 task(s) of available 32 on your kafka cluster")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetInvitations",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"2ed9a5365689abc461ba670094cd7f9a"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY"
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"c6a87bf5-3cbf-4e40-b147-4a806ec54e6d",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:18:08.676Z",
"type":"io.confluent.cloud/request"
}
ResendInvitation¶
The ResendInvitation event is generated by a request to resend an invitation.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"ResendInvitation",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"USER_INVITATION",
"resourceId":"i-xqjzq"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"86a6cf91cea821322f20422c330e955d"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"i-xqjzq"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/user-invitation=i-xqjzq",
"specversion":"1.0",
"id":"9203b5df-31b5-457e-a2a8-27c89a820091",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:22:35.605Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Invitation Not Found")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"ResendInvitation",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"ca1c92e2b4d746cb61e0034ebeb6e552"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"id":"i-sdf"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"source":{
},
"id":"ca1c92e2b4d746cb61e0034ebeb6e552",
"status":"404",
"detail":"Invitation Not Found"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"7b87a915-3c96-4a6d-818d-e96a6482bed8",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:23:27.245Z",
"type":"io.confluent.cloud/request"
}
Sign-in attempt¶
Included here are the actions, or operations, on a sign-in attempt that generate auditable event messages.
| Method name | Action triggering an auditable event message |
|---|---|
| SignIn | A request to sign in to a Confluent Cloud resource. |
SignIn¶
The SignIn event is generated by a request to sign in to a Confluent Cloud resource
with a local or single sign-on (SSO) user account. For details about local and SSO
accounts, see User account types.
Examples¶
SUCCESS – Local user account sign-in attempt
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"SignIn",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"123-3f43-34-34-52b8da259e5c"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-12"
}
},
"result":"SUCCESS",
"credentials":{
"idTokenCredentials":{
},
"mechanism":"HTTP_BEARER"
}
},
"requestMetadata":{
"requestId":[
"8c0ee67f8048ff9bbd25d53d1b9cab68"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c"
},
"subject":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c",
"specversion":"1.0",
"id":"4e42e083-bcb8-4880-a670-b70541ffbf2c",
"source":"crn://confluent.cloud/",
"time":"2022-06-08T23:03:59.078Z",
"type":"io.confluent.cloud/request"
}
SUCCESS – SSO user account sign-in attempt
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"SignIn",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"1234-2345-234"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-1234"
}
},
"result":"SUCCESS",
"credentials":{
"idTokenCredentials":{
"issuer":"confluent"
},
"mechanism":"HTTP_BEARER"
}
},
"requestMetadata":{
"requestId":[
"15412344a32c31e433727ca095e133b1"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=1234-2345-234"
},
"subject":"crn://confluent.cloud/organization=1234-2345-234",
"specversion":"1.0",
"id":"e585b132-0aeb-4401-ae3f-cd2ee91a4a10",
"source":"crn://confluent.cloud/",
"time":"2022-06-08T20:58:40.463Z",
"type":"io.confluent.cloud/request"
}
SUCCESS – SSO user account sign-in attempt (includes assignedPrincipals property)
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"SignIn",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"123-3f43-34-34-52b8da259e5c"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-12"
}
},
"result":"SUCCESS",
"credentials":{
"idTokenCredentials":{
},
"mechanism":"HTTP_BEARER"
}
},
"requestMetadata":{
"requestId":[
"8c0ee67f8048ff9bbd25d53d1b9cab68"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"result":{
"status":"SUCCESS",
"data":{
"assigned_principals":[
"u-12"
]
}
},
"resourceName":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c"
},
"subject":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c",
"specversion":"1.0",
"id":"4e42e083-bcb8-4880-a670-b70541ffbf2c",
"source":"crn://confluent.cloud/",
"time":"2022-06-08T23:03:59.078Z",
"type":"io.confluent.cloud/request"
}
FAILURE – Local user account sign-in attempt with invalid credentials
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"SignIn",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"123-3f43-34-34-52b8da259e5c"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com"
},
"result":"FAILURE"
},
"requestMetadata":{
"requestId":[
"ca9bf33802b486cdfeffe67f36d713e9"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"91c9100425c8bf2c507e5d7f443c6d99",
"status":"401",
"detail":"Invalid username or password.",
"source":{}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c"
},
"subject":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c",
"specversion":"1.0",
"id":"bf55994b-3e0d-4751-8453-6d998291cd7b",
"source":"crn://confluent.cloud/",
"time":"2023-05-25T10:26:42.418708531Z",
"type":"io.confluent.cloud/request"
}
FAILURE – SSO login is required for this organization
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"SignIn",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"123-3f43-34-34-52b8da259e5c"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com"
},
"result":"FAILURE"
},
"requestMetadata":{
"requestId":[
"ca9bf33802b486cdfeffe67f36d713e9"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"id":"id1",
"status":"403",
"detail":"SSO login is required for this organization.",
"source":{}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c"
},
"subject":"crn://confluent.cloud/organization=123-3f43-34-34-52b8da259e5c",
"specversion":"1.0",
"id":"bf55994b-3e0d-4751-8453-6d998291cd7b",
"source":"crn://confluent.cloud/",
"time":"2023-05-25T10:26:42.418708531Z",
"type":"io.confluent.cloud/request"
}
Single sign-on (SSO) connection¶
Included here are the actions, or operations, on a sign-on (SSO) connection that generate auditable event messages. For more about SSO, see Single Sign-on (SSO) for Confluent Cloud.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateSSOConnection | A request to create an SSO connection. |
| DeleteSSOConnection | A request to delete an SSO connection. |
| GetSSOConnection | A request to get the details of an SSO connection. |
| UpdateSSOConnection | A request to update the SSO connection for an organization. |
CreateSSOConnection¶
The CreateSSOConnection event is generated by a request to create an
SSO connection.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "9bf7ecde-5b13-4089-9c8b-fd7a0f91f8d4",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time": "2021-10-21T09:10:07.62875453Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateSSOConnection",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource": {
"type": "SSO_CONNECTION",
"resourceId": "test-auth"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-l93dom"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"e405bf61d00c4874187a4adf3a0f64e5"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"connection_name": "test-auth",
"id": "",
"kind": "SsoConnection",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self": ""
},
"api_version": "v2"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "",
"kind": "SsoConnection",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self": ""
},
"api_version": "v2",
"connection_name": "test-auth"
}
},
"resourceName": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
FAILURE ("Fail to create sso connection ...")
{
"specversion": "1.0",
"id": "0ce1e077-f03d-47a9-bc48-79614881d486",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=a90aec1e-96bf-4dd9-b5eb-56acd9152319/sso-connection=test-sso-connection-valid",
"time": "2021-10-20T23:11:17.076708623Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateSSOConnection",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "a90aec1e-96bf-4dd9-b5eb-56acd9152319"
}
]
},
"resource": {
"type": "SSO_CONNECTION",
"resourceId": "test-sso"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-12wqyz"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"81256154f987318138b4cd0f5eecdd78"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"connection_name": "test-sso",
"id": "",
"kind": "SsoConnection",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=a90aec1e-96bf-4dd9-b5eb-56acd9152319/sso-connection=test-sso-connection-valid",
"self": ""
},
"api_version": "v2"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "81256154f987318138b4cd0f5eecdd78",
"status": "400",
"detail": "Fail to create sso connection: The signing certificate is not valid. Please provide a .pem or .cer certificate base64 encoded public key",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=a90aec1e-96bf-4dd9-b5eb-56acd9152319/sso-connection=test-sso-connection-valid"
}
}
DeleteSSOConnection¶
The DeleteSSOConnection is generated by a request to delete an SSO connection.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "808d74a5-1742-4f36-9679-d840f3397e89",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time": "2021-10-21T01:09:41.352176377Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteSSOConnection",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource": {
"type": "SSO_CONNECTION",
"resourceId": "test-auth"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-l93dom"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"958ea951158e3cc56df5763e260ba78b"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"connection_name": "test-auth",
"enabled": true,
"kind": "SsoConnection",
"metadata": {
"resource_name": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self": ""
}
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
FAILURE ("Could not check if credentials exist ...")
{
"specversion": "1.0",
"id": "937ecd0a-7f00-44fe-82d8-c49112042865",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/sso-connection=conf-prod",
"time": "2021-10-26T11:00:09.891513928Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteSSOConnection",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "c5e50abf-6ba7-4926-a39c-6008f49f5075"
}
]
},
"resource": {
"type": "SSO_CONNECTION",
"resourceId": "conf-prod"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-97pp07"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"6eb3da6243c6f67484bff78b380c8b35"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"metadata": {
"resource_name": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/sso-connection=conf-prod",
"self": ""
},
"api_version": "v2",
"connection_name": "conf-prod",
"enabled": true,
"kind": "SsoConnection"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "6eb3da6243c6f67484bff78b380c8b35",
"status": "500",
"detail": "Could not check if credentials exist: Auth0: Could not get credentials: Auth0: Could not execute ListByEmail query in Auth0: json: cannot unmarshal string into Go struct field User.email_verified of type bool: Error while calling authClient.CredentialsExist",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/sso-connection=conf-prod"
}
}
GetSSOConnection¶
The GetSSOConnection is generated by a request to get the details of an SSO connection.
Examples¶
SUCCESS
{
"specversion":"1.0",
"id":"9bf7ecde-5b13-4089-9c8b-fd7a0f91f8d4",
"source":"crn://confluent.cloud/",
"type":"io.confluent.cloud/request",
"datacontenttype":"application/json",
"subject":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time":"2021-10-21T09:10:07.62875453Z",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetSSOConnection",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource":{
"type":"SSO_CONNECTION",
"resourceId":"test-auth"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-l93dom"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"e405bf61d00c4874187a4adf3a0f64e5"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"connection_name":"test-auth",
"id":"",
"kind":"SsoConnection",
"metadata":{
"resource_name":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self":""
},
"api_version":"v2"
}
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
FAILURE ("Forbidden Access")
{
"specversion":"1.0",
"id":"9bf7ecde-5b13-4089-9c8b-fd7a0f91f8d4",
"source":"crn://confluent.cloud/",
"type":"io.confluent.cloud/request",
"datacontenttype":"application/json",
"subject":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time":"2021-10-21T09:10:07.62875453Z",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetSSOConnection",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource":{
"type":"SSO_CONNECTION",
"resourceId":"test-auth"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-l93dom"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"e405bf61d00c4874187a4adf3a0f64e5"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"connection_name":"test-auth",
"id":"",
"kind":"SsoConnection",
"metadata":{
"resource_name":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self":""
},
"api_version":"v2"
}
},
"result":{
"status":"FAILURE",
"schema":"$def/components/schemas/Failure",
"data":{
"errors":[
{
"code":"forbidden",
"detail":"Forbidden",
"source":{
},
"status":"403"
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
UpdateSSOConnection¶
The UpdateSSOConnection is generated by a request to update the details of
an SSO connection.
Examples¶
SUCCESS
{
"specversion":"1.0",
"id":"9bf7ecde-5b13-4089-9c8b-fd7a0f91f8d4",
"source":"crn://confluent.cloud/",
"type":"io.confluent.cloud/request",
"datacontenttype":"application/json",
"subject":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time":"2021-10-21T09:10:07.62875453Z",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateSSOConnection",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource":{
"type":"SSO_CONNECTION",
"resourceId":"test-auth"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-l93dom"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"e405bf61d00c4874187a4adf3a0f64e5"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"connection_name":"test-auth",
"id":"",
"kind":"SsoConnection",
"metadata":{
"resource_name":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self":""
},
"api_version":"v2",
"signing_cert_updated":true,
"fields_map_updated":false
}
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
FAILURE ("Invitation Not Found")
{
"specversion":"1.0",
"id":"9bf7ecde-5b13-4089-9c8b-fd7a0f91f8d4",
"source":"crn://confluent.cloud/",
"type":"io.confluent.cloud/request",
"datacontenttype":"application/json",
"subject":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"time":"2021-10-21T09:10:07.62875453Z",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateSSOConnection",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"1074fcd3-5b24-4f62-89a4-b37a5f77afe3"
}
]
},
"resource":{
"type":"SSO_CONNECTION",
"resourceId":"test-auth"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-l93dom"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"e405bf61d00c4874187a4adf3a0f64e5"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"connection_name":"test-auth",
"id":"",
"kind":"SsoConnection",
"metadata":{
"resource_name":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth",
"self":""
},
"api_version":"v2",
"signing_cert_updated":true,
"fields_map_updated":false
}
},
"result":{
"status":"FAILURE",
"schema":"$def/components/schemas/Failure",
"data":{
"errors":[
{
"code":"forbidden",
"detail":"Forbidden",
"source":{
},
"status":"403"
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=1074fcd3-5b24-4f62-89a4-b37a5f77afe3/sso-connection=test-auth"
}
}
Environment¶
Included here are the actions, or operations, on a Confluent Cloud environment that generate auditable event messages. For more about environments, see Environments in Confluent Cloud.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateEnvironment | A request to create an environment. |
| DeleteEnvironment | A request to delete an environment. |
| GetEnvironment | A request to get the details of an environment in the organization. |
| GetEnvironments | A request to get a list of environments in the organization. |
| UpdateEnvironment | A request to update an environment. |
CreateEnvironment¶
The CreateEnvironment event is generated by a request to create an environment.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "cb44df11-ecb0-4a6c-8e15-a1ae7bda1206",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=7bc94a4e-d44d-40bf-912c-77036866eabd/environment=env-7nk8vo",
"time": "2021-10-20T22:43:18.906895813Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateEnvironment",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "7bc94a4e-d44d-40bf-912c-77036866eabd"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-7nk8vo"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-lg8vpn"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"accaf0697477b9930d1f336f687d1bb7"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"display_name": "rbacOrg3-env2",
"kind": "Environment"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "env-7nk8vo",
"kind": "Environment",
"metadata": {
"updated_at": "2021-10-20T22:43:18.888725Z",
"created_at": "2021-10-20T22:43:18.888725Z",
"resource_name": "crn://confluent.cloud/environment=env-7nk8vo",
"self": "https://api.confluent.cloud/v2/environments/env-7nk8vo"
},
"api_version": "v2",
"display_name": "rbacOrg3-env2"
}
},
"resourceName": "crn://confluent.cloud/organization=7bc94a4e-d44d-40bf-912c-77036866eabd/environment=env-7nk8vo"
}
}
FAILURE ("Environment name is already in use")
You can edit an environment name in the Confluent Cloud Console or change an existing
name with the Confluent CLI confluent environment update command.
To see a list of existing environment names, use the Confluent CLI
confluent environment list command.
{
"specversion": "1.0",
"id": "70ababee-9ce2-4d8f-a2b5-e1d054fab8a9",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=1da5eac0-96dd-4745-8b24-08c58f0cc905",
"time": "2021-10-21T01:14:01.515290748Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateEnvironment",
"cloudResources": [
{
"resource": {
"type": "ORGANIZATION",
"resourceId": "1da5eac0-96dd-4745-8b24-08c58f0cc905"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-425nm4"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"a7f2e95fbc5f01b2476cbe9298d40b28"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"kind": "Environment",
"api_version": "v2",
"display_name": "display-name"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "a7f2e95fbc5f01b2476cbe9298d40b28",
"status": "409",
"detail": "Environment name is already in use",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=1da5eac0-96dd-4745-8b24-08c58f0cc905"
}
}
DeleteEnvironment¶
The DeleteEnvironment event is generated by a request to delete an environment.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "c08b41f9-4b8e-4dcd-adfd-f680459f373e",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=5e6d53b3-d39d-4b36-98e6-1592eb4629a9/environment=env-oqzd3p",
"time": "2021-10-21T01:13:53.968277462Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteEnvironment",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "5e6d53b3-d39d-4b36-98e6-1592eb4629a9"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-oqzd3p"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-em5rz2"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"1c05cfdf320c7742a1425ead0a3518ad"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"id": "env-oqzd3p",
"kind": "Environment"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=5e6d53b3-d39d-4b36-98e6-1592eb4629a9/environment=env-oqzd3p"
}
}
FAILURE ("Forbidden Access")
{
"specversion": "1.0",
"id": "d474b893-9d80-4921-9df6-d1a344306ddf",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=9c502da1-afc1-44cf-b5f0-7699d33c2b5a/environment=env-xm6gdz",
"time": "2021-10-21T09:13:09.816482792Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteEnvironment",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "9c502da1-afc1-44cf-b5f0-7699d33c2b5a"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-xm6gdz"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-o3xwv9"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"b9c38b6c64c7f2567e22650fee48964f"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"api_version": "v2",
"id": "env-xm6gdz",
"kind": "Environment"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"code": "forbidden_access",
"detail": "Forbidden Access",
"source": {},
"id": "b9c38b6c64c7f2567e22650fee48964f",
"status": "403"
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=9c502da1-afc1-44cf-b5f0-7699d33c2b5a/environment=env-xm6gdz"
}
}
GetEnvironment¶
The GetEnvironment event is generated by a request to get the details of an environment.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetEnvironment",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"ENVIRONMENT",
"resourceId":"env-8wppwr"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"072d0d18b99ec3723dcaab343cc2ea7b"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"env-8wppwr"
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/environment=env-8wppwr",
"specversion":"1.0",
"id":"b26ff929-b94d-4b51-b3ba-6cc0175ae4e0",
"source":"crn://confluent.cloud/",
"time":"2022-03-04T23:51:35.439Z",
"type":"io.confluent.cloud/request"
}
FAILURE ("Forbidden Access")
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetEnvironment",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"7405ea5a4a4dd3ff42f49d97f9424b78"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"id":"env-wefdwq"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"detail":"Forbidden Access",
"source":{
},
"id":"7405ea5a4a4dd3ff42f49d97f9424b78",
"status":"403",
"code":"forbidden_access"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"0b01d8b2-3423-4d47-96ce-481415add025",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:02:42.458Z",
"type":"io.confluent.cloud/request"
}
GetEnvironments¶
The GetEnvironments event is generated by a request to get a list of the
environments in an organization.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetEnvironments",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"65fa5b282a3b02bedad6977abb18ed2a"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY"
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"0b62905d-b539-4468-882b-2b089da42f9a",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:04:03.501Z",
"type":"io.confluent.cloud/request"
}
UpdateEnvironment¶
The UpdateEnvironment event is generated by a request to update the details
of an environment.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateEnvironment",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
]
},
"resource":{
"type":"ENVIRONMENT",
"resourceId":"env-8wppwr"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"dc2cbc3c5106d4de30659992bcf089b7"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"api_version":"org/v2",
"display_name":"display-name",
"id":"env-8wppwr",
"kind":"Environment",
"metadata":{
"resource_name":"crn://confluent.cloud/environment=env-8wppwr",
"self":"https://api.confluent.cloud/v2/environments/env-8wppwr"
}
}
},
"result":{
"status":"SUCCESS"
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f/environment=env-8wppwr",
"specversion":"1.0",
"id":"9d1e2162-806e-426a-b9f5-42505d1e3b77",
"source":"crn://confluent.cloud/",
"time":"2022-03-04T23:49:45.563Z",
"type":"io.confluent.cloud/request"
}
FAILURE - Forbidden Access
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"UpdateEnvironment",
"cloudResources":[
{
"resource":{
"type":"ORGANIZATION",
"resourceId":"fcbc58be-deda-4559-bfb0-f5558124e01f"
}
}
],
"authenticationInfo":{
"principal":{
"email":"someone@example.com",
"confluentUser":{
"resourceId":"u-5721zz"
}
},
"result":"SUCCESS"
},
"requestMetadata":{
"requestId":[
"608f6908c470f28d4afae4e909559404"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"MODIFICATION",
"data":{
"metadata":{
"resource_name":"crn://confluent.cloud/environment=env-wefdwq",
"self":"https://api.confluent.cloud/org/v2/environments/env-wefdwq"
},
"api_version":"org/v2",
"display_name":"prod-finance01",
"id":"env-wefdwq",
"kind":"Environment"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"status":"403",
"code":"forbidden_access",
"detail":"Forbidden Access",
"source":{
},
"id":"608f6908c470f28d4afae4e909559404"
}
]
}
}
},
"subject":"crn://confluent.cloud/organization=fcbc58be-deda-4559-bfb0-f5558124e01f",
"specversion":"1.0",
"id":"4e1320fd-abd8-4449-84d5-5da9c9abbe93",
"source":"crn://confluent.cloud/",
"time":"2022-03-05T00:00:36.648Z",
"type":"io.confluent.cloud/request"
}
Schema Registry cluster¶
Included here are the actions, or operations, on a Confluent Cloud Schema Registry cluster that generate auditable event messages. For details about Confluent Cloud Schema Registry, see Manage Schemas in Confluent Cloud.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateSchemaRegistryCluster | A request to create a Schema Registry cluster. |
| DeleteSchemaRegistryCluster | A request to delete a Schema Registry cluster. |
| GetSchemaRegistryCluster | A request to get the details of a Schema Registry cluster. |
| ListSchemaRegistryClusters | A request to get a list of the Schema Registry clusters in the organization. |
CreateSchemaRegistryCluster¶
The CreateSchemaRegistryCluster event is generated by a request to create
a Schema Registry cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"subject": "crn://confluent.cloud/organization=org-uuid/environment=the-account/schema-registry=lsrc-1",
"datacontenttype": "application/json",
"data": {
"service_name": "crn://confluent.cloud/",
"method_name": "CreateSchemaRegistryCluster",
"cloud_resources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resource_id": "org-uuid"
},
{
"type": "ENVIRONMENT",
"resource_id": "the-account"
}
]
},
"resource": {
"type": "SCHEMA_REGISTRY",
"resource_id": "lsrc-1"
}
}
],
"authentication_info": {
"exposure": "CUSTOMER",
"principal": {
"confluentUser": {
"resource_id": "u-99"
}
},
"result": "SUCCESS"
},
"request_metadata": {
"request_id": [
"request-id-1234"
],
"client_address": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"access_type": "MODIFICATION",
"data": {
"account_id": "the-account",
"location": "US",
"service_provider": "gcp"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "lsrc-1"
}
}
}
}
DeleteSchemaRegistryCluster¶
The DeleteSchemaRegistryCluster event is generated by a request to delete
a Schema Registry cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"subject": "crn://confluent.cloud/organization=org-uuid/environment=the-account/schema-registry=lsrc1",
"datacontenttype": "application/json",
"data": {
"service_name": "crn://confluent.cloud/",
"method_name": "DeleteSchemaRegistryCluster",
"cloud_resources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resource_id": "org-uuid"
},
{
"type": "ENVIRONMENT",
"resource_id": "the-account"
}
]
},
"resource": {
"type": "SCHEMA_REGISTRY",
"resource_id": "lsrc1"
}
}
],
"authentication_info": {
"exposure": "CUSTOMER",
"principal": {
"confluentUser": {
"resource_id": "u-99",
}
},
"result": "SUCCESS"
},
"request_metadata": {
"request_id": [
"request-id-1234"
],
"client_address": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"access_type": "MODIFICATION",
"data": {
"account_id": "the-account",
"id": "lsrc1"
}
},
"result": {
"status": "SUCCESS"
}
}
}
GetSchemaRegistryCluster¶
The GetSchemaRegistryCluster event is generated by a request to get the
details of a Schema Registry cluster.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"GetSchemaRegistryCluster",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"49803d36-1f69-40d0-b0b0-b563f84c6f0c"
},
{
"type":"ENVIRONMENT",
"resourceId":"env-psxcdozkc1y"
}
]
},
"resource":{
"type":"SCHEMA_REGISTRY",
"resourceId":"lsrc-psxdcznuoe3"
}
}
],
"authenticationInfo":{
"principal":{
"email":"user@example.com",
"confluentUser":{
"resourceId":"u-152js5"
}
},
"result":"SUCCESS",
"identity":"crn://confluent.cloud/organization=49803d36-1f69-40d0-b0b0-b563f84c6f0c/identity-provider=Confluent/identity=u-143js5"
},
"requestMetadata":{
"requestId":[
"0b0b72724778781ce0d563db6e8ee40f"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"env_id":"env-psxccozkd1y",
"id":"lsrc-psxdcznvod3"
}
},
"result":{
"status":"FAILURE",
"data":{
"errors":[
{
"status":"403",
"code":"forbidden_access",
"detail":"Forbidden Access",
"source":{
}
}
]
}
},
"resourceName":"crn://confluent.cloud/organization=49803d36-1f69-40d0-b0b0-b563f84c6f0c/environment=env-psxccozkd1y/schema-registry=lsrc-psxdcznvod3"
},
"subject":"crn://confluent.cloud/organization=49803d36-1f69-40d0-b0b0-b563f84c6f0c/environment=env-psxccozkd1y/schema-registry=lsrc-psxdcznvod3",
"specversion":"1.0",
"id":"ba12365e-98b5-4180-b5a9-ca597d216920",
"source":"crn://confluent.cloud/",
"time":"2023-09-14T16:24:23.244262859Z",
"type":"io.confluent.cloud/request"
}
ListSchemaRegistryClusters¶
The ListSchemaRegistryClusters event is generated by a request to get a
list of the Schema Registry clusters in the organization.
Examples¶
SUCCESS
{
"datacontenttype":"application/json",
"data":{
"serviceName":"crn://confluent.cloud/",
"methodName":"ListSchemaRegistryClusters",
"cloudResources":[
{
"scope":{
"resources":[
{
"type":"ORGANIZATION",
"resourceId":"095d2340-bef4-41d7-b537-9804d34e18fd"
}
]
},
"resource":{
"type":"ENVIRONMENT",
"resourceId":"env-3732nw"
}
}
],
"authenticationInfo":{
"principal":{
"email":"user@example.com",
"confluentUser":{
"resourceId":"u-r9182o"
}
},
"result":"SUCCESS",
"identity":"crn://confluent.cloud/organization=095d2340-bef4-41d7-b537-9804d34e18fd/identity-provider=Confluent/identity=u-r9182o"
},
"requestMetadata":{
"requestId":[
"b9ec89a595d6902590b42900155bfabe"
],
"clientAddress":[
{
"ip":"1.2.3.4"
}
]
},
"request":{
"accessType":"READ_ONLY",
"data":{
"environment_id":"env-3841mx"
}
},
"result":{
"status":"SUCCESS"
},
"resourceName":"crn://confluent.cloud/organization=095d2340-bef4-41d7-b537-9804d34e18fd/environment=env-3732nw"
},
"subject":"crn://confluent.cloud/organization=095d2340-bef4-41d7-b537-9804d34e18fd/environment=env-3841mx",
"specversion":"1.0",
"id":"e15471b5-9562-4163-97e0-c220ecaa8657",
"source":"crn://confluent.cloud/",
"time":"2023-11-02T18:56:28.121065089Z",
"type":"io.confluent.cloud/request"
}
Kafka cluster¶
Included here are the actions, or operations, on a Kafka cluster that generate auditable event messages. For more about clusters, see Confluent Cloud Clusters.
| Method name | Action triggering an auditable event message |
|---|---|
| CreateKafkaCluster | A request to create a Kafka cluster. |
| DeleteKafkaCluster | A request to delete a Kafka cluster. |
| GetKafkaCluster | A request to query for details about a Kafka cluster. |
| GetKafkaClusters | A request to query for a list of Kafka clusters. |
| UpdateKafkaCluster | A request to update a Kafka cluster. |
CreateKafkaCluster¶
The CreateKafkaCluster event is generated by a request to create a Kafka cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "63408abb-91ce-48a6-99a8-b1c2ea0f85cc",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=7bc94a4e-d44d-40bf-912c-77036866eabd/environment=env-7nk8vo/kafka-cluster=lkc-3nqrzw",
"time": "2021-10-20T22:43:25.049383803Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "7bc94a4e-d44d-40bf-912c-77036866eabd"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-7nk8vo"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-3nqrzw"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-epvznk"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"a952c2891181722bc9f09e37a20d7e9b"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"name": "rbacOrg",
"account_id": "env-7nk8vo",
"region": "us-west-2",
"service_provider": "aws"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "lkc-3nqrzw"
}
},
"resourceName": "crn://confluent.cloud/organization=7bc94a4e-d44d-40bf-912c-77036866eabd/environment=env-7nk8vo/kafka-cluster=lkc-3nqrzw"
}
}
FAILURE ("resource not found")
{
"specversion": "1.0",
"id": "d8f49311-6113-4daf-add7-490b349ec67f",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=63250efe-89b9-4e3e-9e5c-e941bb987939/environment=env-7nyqx1",
"time": "2021-10-21T00:22:11.612132641Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "63250efe-89b9-4e3e-9e5c-e941bb987939"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-7nyqx1"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-97wkgv"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"6e5243c72a6112c10d5f61a105c92f4d"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"name": "kafka_test",
"account_id": "env-7nyqx1",
"region": "us-west-2",
"service_provider": "aws"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "6e5243c72a6112c10d5f61a105c92f4d",
"status": "404",
"detail": "resource not found",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=63250efe-89b9-4e3e-9e5c-e941bb987939/environment=env-7nyqx1"
}
}
DeleteKafkaCluster¶
The DeleteKafkaCluster event is generated by a request to delete a Kafka cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "f290139d-46c4-481b-bbd0-3ce1b4bd3171",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=728dfe10-d6e2-48da-b7fc-ac06133d1526/environment=env-2r5ooo/kafka-cluster=lkc-9wjzy7",
"time": "2021-10-21T09:01:19.953578129Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "728dfe10-d6e2-48da-b7fc-ac06133d1526"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-2r5ooo"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-9wjzy7"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-4k7d5m"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"eb4f06e546b3042f2ab3ceba4046441a"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"account_id": "env-2r5ooo",
"id": "lkc-9wjzy7"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=728dfe10-d6e2-48da-b7fc-ac06133d1526/environment=env-2r5ooo/kafka-cluster=lkc-9wjzy7"
}
}
FAILURE ("kafka service: failed to sync cr")
{
"specversion": "1.0",
"id": "dce9546e-676e-479b-9e58-0ae3ce42ffd6",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=5e6d53b3-d39d-4b36-98e6-1592eb4629a9/environment=env-r5v3k0/kafka-cluster=lkc-z3v310",
"time": "2021-10-21T04:15:42.151169542Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "5e6d53b3-d39d-4b36-98e6-1592eb4629a9"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-r5v3k0"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-z3v310"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-em5rz2"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"811a180eb09da46d0c83134b2fb6531a"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"id": "lkc-z3v310",
"account_id": "env-r5v3k0"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "811a180eb09da46d0c83134b2fb6531a",
"status": "500",
"detail": "kafka service: failed to sync cr : failed to get logical clusters",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=5e6d53b3-d39d-4b36-98e6-1592eb4629a9/environment=env-r5v3k0/kafka-cluster=lkc-z3v310"
}
}
GetKafkaCluster¶
The GetKafkaCluster event is generated by a request to query the details of a Kafka cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "fab5da73-f2d6-43e2-962a-14b5b5e1b6fb",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/environment=env-knnrw6/kafka-cluster=lkc-j8d8kp",
"time": "2021-10-21T08:39:44.61121985Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "c5e50abf-6ba7-4926-a39c-6008f49f5075"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-knnrw6"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-j8d8kp"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-97pp07"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"62a9d71dd3d1edb7557424639ad7c41b"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"id": "lkc-j8d8kp",
"account_id": "env-knnrw6"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/environment=env-knnrw6/kafka-cluster=lkc-j8d8kp"
}
}
FAILURE ("forbidden access")
{
"specversion": "1.0",
"id": "32b7ed88-7873-4b93-9b26-3ac2b4691a09",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=68ae1c83-36f7-42ce-b420-e18ba359be68/environment=env-zgj183/kafka-cluster=lkc-8m9w90",
"time": "2021-10-20T22:42:42.268650597Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "68ae1c83-36f7-42ce-b420-e18ba359be68"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-zgj183"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-8m9w90"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-41x7gz"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"54bef6c6ea068d647357f76553980010"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"id": "lkc-8m9w90",
"account_id": "env-zgj183"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"status": "403",
"code": "forbidden_access",
"detail": "Forbidden Access",
"source": {},
"id": "54bef6c6ea068d647357f76553980010"
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=68ae1c83-36f7-42ce-b420-e18ba359be68/environment=env-zgj183/kafka-cluster=lkc-8m9w90"
}
}
GetKafkaClusters¶
The GetKafkaClusters event is generated by a request to get a list of the
Kafka clusters in the organization.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "66b7018c-5ece-4aa4-a683-634e10f34ff7",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=68ae1c83-36f7-42ce-b420-e18ba359be68/environment=env-nwrg7k",
"time": "2021-10-20T22:41:54.594828522Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKafkaClusters",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "68ae1c83-36f7-42ce-b420-e18ba359be68"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-nwrg7k"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-43jq9o"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"849b829cdf48e53fb141f6eb09999c55"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"account_id": "env-nwrg7k"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=68ae1c83-36f7-42ce-b420-e18ba359be68/environment=env-nwrg7k"
}
}
FAILURE ("Authz: MDS Authorize returned error")
Because the GetKafkaClusters method calls the mds.Authorize method,
an event message is also created for that event.
{
"specversion": "1.0",
"id": "a93102c3-b4d2-42bc-8aee-1660b390450b",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=a90deb36-9f5f-48d3-99d9-a47132999f5f/environment=env-v7d1v5",
"time": "2021-10-21T02:11:23.724123384Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKafkaClusters",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "a90deb36-9f5f-48d3-99d9-a47132999f5f"
}
]
},
"resource": {
"type": "ENVIRONMENT",
"resourceId": "env-v7d1v5"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-yo03oo"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"ffe22c315f901a14803248ea97cdcf97"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"account_id": "env-v7d1v5"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "ffe22c315f901a14803248ea97cdcf97",
"status": "500",
"code": "internal_error",
"detail": "Authz: MDS Authorize returned error",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=a90deb36-9f5f-48d3-99d9-a47132999f5f/environment=env-v7d1v5"
}
}
UpdateKafkaCluster¶
The UpdateKafkaCluster event is generated by a request to update the details
of a Kafka cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "d2420469-0cc3-4db3-8115-0654343bce87",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=2ef8a041-2bad-4363-980b-c20167d77eea/environment=env-vr18gp/kafka-cluster=lkc-v1o1p0",
"time": "2021-10-21T00:16:02.296194122Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "UpdateKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "2ef8a041-2bad-4363-980b-c20167d77eea"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-vr18gp"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-v1o1p0"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-4kmo2e"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"e2469fecbf0b6c59fc7813676ec976a2"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"id": "lkc-v1o1p0",
"account_id": "env-vr18gp"
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=2ef8a041-2bad-4363-980b-c20167d77eea/environment=env-vr18gp/kafka-cluster=lkc-v1o1p0"
}
}
FAILURE ("Your cluster update config is invalid ...")
{
"specversion": "1.0",
"id": "bcc261fa-752a-4ff2-b942-affb29ccca0e",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"datacontenttype": "application/json",
"subject": "crn://confluent.cloud/organization=2ef8a041-2bad-4363-980b-c20167d77eea/environment=env-vr18gp/kafka-cluster=lkc-19793j",
"time": "2021-10-21T03:21:25.770497704Z",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "UpdateKafkaCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "2ef8a041-2bad-4363-980b-c20167d77eea"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-vr18gp"
}
]
},
"resource": {
"type": "KAFKA_CLUSTER",
"resourceId": "lkc-19793j"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-4kmo2e"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"cf7d09e333d25781172df273d87bc75a"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"id": "lkc-19793j",
"name": "update_name",
"account_id": "env-vr18gp"
}
},
"result": {
"status": "FAILURE",
"data": {
"errors": [
{
"id": "cf7d09e333d25781172df273d87bc75a",
"status": "400",
"detail": "Your cluster update config is invalid. Please check documentation for more details, for example, multi-zone clusters cannot be downscaled below 2 CKUs.",
"source": {}
}
]
}
},
"resourceName": "crn://confluent.cloud/organization=2ef8a041-2bad-4363-980b-c20167d77eea/environment=env-vr18gp/kafka-cluster=lkc-19793j"
}
}
ksqlDB cluster¶
The following actions, or operations, on a ksqlDB cluster generate auditable event messages. For details about ksqlDB clusters, see ksqlDB in Confluent Cloud.
| Method name | Action triggering an audit log event message |
|---|---|
| CreateKSQLCluster | A request to create a ksqlDB cluster |
| DeleteKSQLCluster | A request to terminate a ksqlDB cluster |
| GetKSQLCluster | A request to get the details of a ksqlDB cluster. |
| GetKSQLClusters | A request to list all ksqlDB clusters in the same environment and organization. |
| PauseKSQLCluster | A request to pause, or suspend, a ksqlDB cluster |
| RestoreKSQLCluster | A request to restore a paused, or deleted, a ksqlDB cluster to active |
| UpdateKSQLCluster | A request to update the configuration of a ksqlDB cluster |
CreateKSQLCluster¶
The CreateKSQLCluster event is generated by a request to create a ksqlDB cluster.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "CreateKSQLCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "bf805046-2772-4233-9fda-17aa47c7b4e2"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-4k8qm"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-84y830z"
},
{
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-m6ywpdq"
}
]
},
"resource": {
"type": "API_KEY",
"resourceId": "YNWWA22SQEMQUNIJ"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-m4nven"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"991dfd522f516078a87bc149439afc82"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"kafka_api_key": {
"key": "YNWWA22SQEMQUNIJ"
},
"name": "ksqlDB_cluster_example",
"account_id": "env-4k8qm",
"kafka_cluster_id": "lkc-84y830z"
}
},
"result": {
"status": "SUCCESS",
"data": {
"physical_cluster_id": "pksqlc-god240n",
"id": "lksqlc-m6ywpdq",
"name": "ksqlDB_cluster_example"
}
}
},
"subject": "crn://confluent.cloud/organization=bf805046-2772-4233-9fda-17aa47c7b4e2/environment=env-4k8qm/cloud-cluster=lkc-84y830z/ksql-cluster=lksqlc-m6ywpdq/api-key=YNWWA22SQEMQUNIJ",
"specversion": "1.0",
"id": "b74732d0-1b2f-4fd9-9849-03a0ebf9833b",
"source": "crn://confluent.cloud/",
"time": "2022-03-11T07:39:44.079Z",
"type": "io.confluent.cloud/request"
}
DeleteKSQLCluster¶
The DeleteKSQLCluster event is generated by a request to delete a ksqlDB cluster.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "DeleteKSQLCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "bf805046-2772-4233-9fda-17aa47c7b4e2"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-4k8qm"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-84y830z"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-m6ywpdq"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-m4nven"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"670c17df17684fa664082362cc6af811"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"id": "lksqlc-m6ywpdq"
}
},
"result": {
"status": "SUCCESS"
}
},
"subject": "crn://confluent.cloud/organization=bf805046-2772-4233-9fda-17aa47c7b4e2/environment=env-4k8qm/cloud-cluster=lkc-84y830z/ksql-cluster=lksqlc-m6ywpdq",
"specversion": "1.0",
"id": "5454362c-2e6a-4d0b-8f9e-8ec8460464b1",
"source": "crn://confluent.cloud/",
"time": "2022-03-11T18:17:29.147Z",
"type": "io.confluent.cloud/request"
}
GetKSQLCluster¶
The GetKSQLCluster event is generated by a request to get the details of a ksqlDB cluster.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKSQLCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "570ce633-4dec-4c01-8087-3417050055b0"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-j3or0w"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-p96292"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-w1kdr9"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-22d6d2"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"66a981c2d03880842e595fb65a07b876"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"id": "lksqlc-w1kdr9",
"account_id": "env-j3or0w"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "lksqlc-w1kdr9",
"name": "ksql-cluster-example",
"physical_cluster_id": "pksqlc-njdp6"
}
},
"resourceName": "crn://confluent.cloud/organization=570ce633-4dec-4c01-8087-3417050055b0/environment=env-j3or0w/cloud-cluster=lkc-p96292/ksql-cluster=lksqlc-w1kdr9"
},
"subject": "crn://confluent.cloud/organization=570ce633-4dec-4c01-8087-3417050055b0/environment=env-j3or0w/cloud-cluster=lkc-p96292/ksql-cluster=lksqlc-w1kdr9",
"specversion": "1.0",
"id": "7fbe6d0f-ae0c-4d94-a89b-799f71134473",
"source": "crn://confluent.cloud/",
"time": "2022-03-10T19:40:40.359Z",
"type": "io.confluent.cloud/request"
}
GetKSQLClusters¶
The GetKSQLClusters event is generated by a request to get a list of the
ksqlDB clusters in the organization.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "GetKSQLClusters",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "570ce633-4dec-4c01-8087-3417050055b0"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-knqj96"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-wzx9pg"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-jvrw82"
}
},
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "570ce633-4dec-4c01-8087-3417050055b0"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-knqj96"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-ny3q83"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-r06rnk"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-22d6d2"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"46bb6899d4bcbef67a2ad683430f7e9a"
],
"clientAddress": [
{
"ip": "1.2.3.4"
}
]
},
"request": {
"accessType": "READ_ONLY",
"data": {
"cluster": {
"account_id": "env-knqj96"
}
}
},
"result": {
"status": "SUCCESS"
},
"resourceName": "crn://confluent.cloud/organization=570ce633-4dec-4c01-8087-3417050055b0/environment=env-knqj96"
},
"subject": "crn://confluent.cloud/organization=570ce633-4dec-4c01-8087-3417050055b0/environment=env-knqj96",
"specversion": "1.0",
"id": "485c33da-b8e5-475c-80b0-812085acf2b3",
"source": "crn://confluent.cloud/",
"time": "2022-03-11T02:28:28.921Z",
"type": "io.confluent.cloud/request"
}
PauseKSQLCluster¶
The PauseKSQLCluster event is generated by a request to pause, or suspend, a ksqlDB cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"subject": "crn://confluent.cloud/organization=org-uuid/environment=the-account/cloud-cluster=lkc-1/ksql-cluster=lksqlc-1",
"datacontenttype": "application/json",
"data": {
"service_name": "crn://confluent.cloud/",
"method_name": "PauseKSQLCluster",
"cloud_resources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resource_id": "org-uuid"
},
{
"type": "ENVIRONMENT",
"resource_id": "the-account"
},
{
"type": "CLOUD_CLUSTER",
"resource_id": "lkc-1"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resource_id": "lksqlc-1"
}
}
],
"authentication_info": {
"exposure": "CUSTOMER",
"principal": {
"confluentUser": {
"resource_id": "u-99"
}
},
"result": "SUCCESS"
},
"request_metadata": {
"request_id": [
"request-id-1234"
],
"client_address": [
{
"ip": "1.2.3.4",
"internal": true
}
],
"request_type": "GRPC"
},
"request": {
"access_type": "MODIFICATION",
"data": {
"id": "lksqlc-1",
"name": "my-ksql"
}
},
"result": {
"status": "SUCCESS"
}
}
}
RestoreKSQLCluster¶
The RestoreKSQLCluster event is generated by a request to restore, or resume,
a ksqlDB cluster.
Examples¶
SUCCESS
{
"specversion": "1.0",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"source": "crn://confluent.cloud/",
"type": "io.confluent.cloud/request",
"subject": "crn://confluent.cloud/organization=org-uuid/environment=the-account/cloud-cluster=lkc-1/ksql-cluster=lksqlc-1",
"datacontenttype": "application/json",
"data": {
"service_name": "crn://confluent.cloud/",
"method_name": "RestoreKSQLCluster",
"cloud_resources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resource_id": "org-uuid"
},
{
"type": "ENVIRONMENT",
"resource_id": "the-account"
},
{
"type": "CLOUD_CLUSTER",
"resource_id": "lkc-1"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resource_id": "lksqlc-1"
}
}
],
"authentication_info": {
"exposure": "CUSTOMER",
"principal": {
"confluentUser": {
"resource_id": "u-99"
}
},
"result": "SUCCESS"
},
"request_metadata": {
"request_id": [
"request-id-1234"
],
"client_address": [
{
"ip": "1.2.3.4",
"internal": true
}
],
"request_type": "GRPC"
},
"request": {
"access_type": "MODIFICATION",
"data": {
"id": "lksqlc-1",
"name": "my-ksql"
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "lksqlc-1",
"name": "my-ksql",
"physical_cluster_id": "pkc-abc"
}
}
}
}
UpdateKSQLCluster¶
The UpdateKSQLCluster event is generated by a request to update the details
of a ksqlDB cluster.
Examples¶
SUCCESS
{
"datacontenttype": "application/json",
"data": {
"serviceName": "crn://confluent.cloud/",
"methodName": "UpdateKSQLCluster",
"cloudResources": [
{
"scope": {
"resources": [
{
"type": "ORGANIZATION",
"resourceId": "bf805046-2772-4233-9fda-17aa47c7b4e2"
},
{
"type": "ENVIRONMENT",
"resourceId": "env-4k8qm"
},
{
"type": "CLOUD_CLUSTER",
"resourceId": "lkc-84y830z"
}
]
},
"resource": {
"type": "KSQL_CLUSTER",
"resourceId": "lksqlc-3vy3m0m"
}
}
],
"authenticationInfo": {
"principal": {
"email": "someone@example.com",
"confluentUser": {
"resourceId": "u-m4nven"
}
},
"result": "SUCCESS"
},
"requestMetadata": {
"requestId": [
"94d0e427c0cacb2e62c1d9c19ca43b5a"
],
"clientAddress": [
{}
]
},
"request": {
"accessType": "MODIFICATION",
"data": {
"id": "lksqlc-3vy3m0m",
"total_num_csu": 8
}
},
"result": {
"status": "SUCCESS",
"data": {
"id": "lksqlc-3vy3m0m",
"name": "ksqlDB_cluster_example",
"physical_cluster_id": "pksqlc-z9d9z0x"
}
}
},
"subject": "crn://confluent.cloud/organization=bf805046-2772-4233-9fda-17aa47c7b4e2/environment=env-4k8qm/cloud-cluster=lkc-84y830z/ksql-cluster=lksqlc-3vy3m0m",
"specversion": "1.0",
"id": "0ab2f4ca-8722-4fd5-a979-911db9a5b65e",
"source": "crn://confluent.cloud/",
"time": "2022-03-12T00:41:32.447Z",
"type": "io.confluent.cloud/request"
}