Organization Auditable Events

Expand all examples | Collapse all examples

Confluent Cloud organization auditable events occur across many Confluent Cloud resources in an organization, including actions, or operations, on:

Environment

Included here are the actions, or operations, on a Confluent Cloud environment that generate auditable event messages. For more about environments, see Confluent Cloud Environments.

Method name Action triggering an auditable event message
CreateEnvironment (examples) A request to create an environment.
DeleteEnvironment (examples) A request to delete an environment.

Examples

CreateEnvironment: Create an environment

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": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-lg8vpn"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "accaf0697477b9930d1f336f687d1bb7"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "api_version": "v2",
        "display_name": "rbacOrg6-env1",
        "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": "rbacOrg6-env1"
      }
    },
    "resourceName": "crn://confluent.cloud/organization=7bc94a4e-d44d-40bf-912c-77036866eabd/environment=env-7nk8vo"
  }
}
FAILURE ("Environment name is already in use")

You can edit a environment name in the Confluent Cloud Console or change an existing name with the Confluent CLI ccloud environment update command.

To see a list of existing environment names, use the Confluent CLI ccloud 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": "example@confluent.io",
        "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": "test-environment"
      }
    },
    "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: Delete an environment

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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"
  }
}

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 (examples) A request to create a Kafka cluster.
DeleteKafkaCluster (examples) A request to delete a Kafka cluster.
GetKafkaCluster (examples) A request to query for details about a Kafka cluster.
GetKafkaClusters (examples) A request to query for a list of Kafka clusters.
UpdateKafkaCluster (examples) A request to update a Kafka cluster.

Examples

CreateKafkaCluster: Create a Kafka cluster

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Delete a Kafka cluster

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Get details of a Kafka cluster

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Get a list of Kafka clusters

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Update a Kafka cluster

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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"
  }
}

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.

Method name Action triggering an audit log event message
CreateAPIKey (examples) 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 (examples) A request to delete an API key.
GetAPIKeys (examples) A request to get a list of the API keys.
UpdateAPIKey (examples) A request to update an API key.

Examples

CreateAPIKey

SUCCESS
{
  "specversion": "1.0",
  "id": "8bd925aa-b3e8-41ae-ada5-1eb956b9c6b9",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
  "time": "2021-10-20T23:16:56.91792524Z",
  "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": "R43PFUP2SDP6V47B"
        }
      },
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "f909d203-5570-4cc3-9a15-712016536934"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-5j8zg"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-dg5nno"
            },
            {
              "type": "KAFKA_CLUSTER",
              "resourceId": "lkc-dg5nno"
            }
          ]
        },
        "resource": {
          "type": "API_KEY",
          "resourceId": "R43PFUP2SDP6V47B"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4nqg6k"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "ebb639f7655be36697f2fa1d90fe991f"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "user_id": 239754,
        "description": "API Key example",
        "logical_clusters": [
          {
            "id": "lkc-dg5nno",
            "type": "kafka"
          }
        ],
        "account_id": "env-5j8zg",
        "organization_id": 87341,
        "user_resource_id": "u-4nqg6k"
      }
    },
    "result": {
      "status": "SUCCESS",
      "data": {
        "key": "R43PFUP2SDP6V47B"
      }
    },
    "resourceName": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
  }
}
FAILURE ("Your Api Keys per Audit Log Cluster is currently limited to 2")
{
  "specversion": "1.0",
  "id": "a233e3ab-99bd-4cbe-91dc-a8e923d35226",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=4b9153dd-a65a-4d4a-b6f6-1e74c5978b1f",
  "time": "2021-10-21T09:17:55.405040481Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "CreateAPIKey",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "4b9153dd-a65a-4d4a-b6f6-1e74c5978b1f"
            }
          ]
        },
        "resource": {
          "type": "SERVICE_ACCOUNT",
          "resourceId": "sa-oqvvyy"
        }
      },
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "4b9153dd-a65a-4d4a-b6f6-1e74c5978b1f"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-j3zdpm"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-nydx9z"
            }
          ]
        },
        "resource": {
          "type": "KAFKA_CLUSTER",
          "resourceId": "lkc-nydx9z"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-3r660w"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "306081f6a19d118ac84cdfed979d110c"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "logical_clusters": [
          {
            "type": "kafka",
            "id": "lkc-nydx9z"
          }
        ],
        "account_id": "env-j3zdpm",
        "service_account": true,
        "organization_id": 311092,
        "user_id": 844535,
        "description": "apikey limit"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "code": "quota_exceeded",
            "detail": "Your Api Keys per Audit Log Cluster is currently limited to 2",
            "source": {},
            "id": "306081f6a19d118ac84cdfed979d110c",
            "status": "402"
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=4b9153dd-a65a-4d4a-b6f6-1e74c5978b1f"
  }
}

DeleteAPIKey: Delete an API key

SUCCESS
{
  "specversion": "1.0",
  "id": "ec322393-67af-48d6-8502-b2ba4b7ff6f8",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
  "time": "2021-10-21T09:16:07.890906086Z",
  "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": "U65TZ6BHCGQZGSHU"
        }
      },
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "f909d203-5570-4cc3-9a15-712016536934"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-5j8zg"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-dg5nno"
            },
            {
              "type": "KAFKA_CLUSTER",
              "resourceId": "lkc-dg5nno"
            }
          ]
        },
        "resource": {
          "type": "API_KEY",
          "resourceId": "U65TZ6BHCGQZGSHU"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4nqg6k"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "f5a332dc987aac81ff76b6612efca9fc"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "account_id": "env-5j8zg",
        "organization_id": 87341,
        "user_resource_id": "u-4nqg6k",
        "key": "U65TZ6BHCGQZGSHU",
        "user_id": 239754,
        "id": 1101983
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
  }
}
FAILURE ("Forbidden access")
{
  "specversion": "1.0",
  "id": "469fdf47-eea5-42e9-a05a-f90813713cb5",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=0b0c7b8c-38d9-446c-9c7d-95b4fda70598/user=u-4vv0mj/api-key=AKLMGEJ5FV5MOI7J",
  "time": "2021-10-20T22:13:20.306296507Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "DeleteAPIKey",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "0b0c7b8c-38d9-446c-9c7d-95b4fda70598"
            },
            {
              "type": "USER",
              "resourceId": "u-4vv0mj"
            }
          ]
        },
        "resource": {
          "type": "API_KEY",
          "resourceId": "AKLMGEJ5FV5MOI7J"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-ep1vm2"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "8d2a2efe2324507d851ab95e54aa42ce"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "key": "AKLMGEJ5FV5MOI7J",
        "user_id": 226089,
        "id": 1100098,
        "account_id": "env-omvox"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "status": "403",
            "code": "forbidden_access",
            "detail": "Forbidden Access",
            "source": {},
            "id": "8d2a2efe2324507d851ab95e54aa42ce"
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=0b0c7b8c-38d9-446c-9c7d-95b4fda70598/user=u-4vv0mj/api-key=AKLMGEJ5FV5MOI7J"
  }
}

GetAPIKeys: Get a list of API keys

SUCCESS
{
  "specversion": "1.0",
  "id": "c091e5fa-bb37-4eed-90e6-9bb46da81e8c",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934",
  "time": "2021-10-21T08:16:48.528753506Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetAPIKeys",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "f909d203-5570-4cc3-9a15-712016536934"
            }
          ]
        },
        "resource": {
          "type": "USER",
          "resourceId": "u-4nqg6k"
        }
      },
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "f909d203-5570-4cc3-9a15-712016536934"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-5j8zg"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-dg5nno"
            }
          ]
        },
        "resource": {
          "type": "KAFKA_CLUSTER",
          "resourceId": "lkc-dg5nno"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4nqg6k"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "8f90dc77c0e8e94a0d641a36b62da6e0"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY",
      "data": {
        "user_id": 239754,
        "internal": {},
        "logical_clusters": [
          {
            "id": "lkc-dg5nno"
          }
        ],
        "account_id": "env-5j8zg",
        "organization_id": 87341
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=f909d203-5570-4cc3-9a15-712016536934"
  }
}
FAILURE ("account not found")
{
  "specversion": "1.0",
  "id": "9bc194fd-c55e-48f3-b468-6c6d798be401",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc/user=u-4vv68j/api-key=LJRVN65BME6H4DFI",
  "time": "2021-10-21T01:47:06.411008109Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetAPIKeys",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc"
            },
            {
              "type": "USER",
              "resourceId": "u-4vv68j"
            }
          ]
        },
        "resource": {
          "type": "API_KEY",
          "resourceId": "LJRVN65BME6H4DFI"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-ep1jw2"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "55b1ef3a2a7cf65491c647c59c171fba"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY",
      "data": {
        "internal": {},
        "account_id": "env-pzr35",
        "organization_id": 80777,
        "key": "LJRVN65BME6H4DFI",
        "user_id": 219537
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "detail": "account not found",
            "source": {},
            "id": "55b1ef3a2a7cf65491c647c59c171fba",
            "status": "404"
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc/user=u-4vv68j/api-key=LJRVN65BME6H4DFI"
  }
}

UpdateAPIKey: Update an API key

SUCCESS
{
  "specversion": "1.0",
  "id": "9a45e745-6b78-493b-b90e-9a937218e56c",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=be3c4d5d-8d7f-4043-9236-339f7725edd7/user=u-4v80d0/api-key=IFKFKQLHUFB7JQJD",
  "time": "2021-10-21T01:52:27.947230389Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "UpdateAPIKey",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "be3c4d5d-8d7f-4043-9236-339f7725edd7"
            },
            {
              "type": "USER",
              "resourceId": "u-4v80d0"
            }
          ]
        },
        "resource": {
          "type": "API_KEY",
          "resourceId": "IFKFKQLHUFB7JQJD"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4v80d0"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "72ed5823ae02e776a944b5a646e2ef38"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "description": "test",
        "key": "IFKFKQLHUFB7JQJD",
        "id": 1100781
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=be3c4d5d-8d7f-4043-9236-339f7725edd7/user=u-4v80d0/api-key=IFKFKQLHUFB7JQJD"
  }
}
FAILURE ("Forbidden Access")
{
  "specversion": "1.0",
  "id": "440f58fe-5342-4a93-a327-4361e8efc9a7",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc/user=u-4vv68j",
  "time": "2021-10-21T01:47:05.36155761Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "UpdateAPIKey",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc"
            }
          ]
        },
        "resource": {
          "type": "USER",
          "resourceId": "u-4vv68j"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-ep1jw2"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "b2c56a2900bcdfdfea3368e45f4b9b61"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "id": 1100765,
        "description": "test-description"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "code": "forbidden_access",
            "detail": "Forbidden Access",
            "source": {},
            "id": "b2c56a2900bcdfdfea3368e45f4b9b61",
            "status": "403"
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=a82042c4-1d1f-4b3d-b79e-2fed9f1f19bc/user=u-4vv68j"
  }
}

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 (examples) A request to create a service account.
DeleteServiceAccount (examples) A request to delete a service account.

Examples

CreateServiceAccount: Create a service account

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": "example@confluent.io",
        "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 ccloud 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 ccloud 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": "example@confluent.io",
        "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: Delete a service account

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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"
  }
}

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 (examples) A request to create an SSO connection.
DeleteSSOConnection (examples) A request to delete an SSO connection.

Examples

CreateSSOConnection: Create an SSO connection

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Delete an SSO connection

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": "example@confluent.io",
        "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": "example@confluent.io",
        "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"
  }
}

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 Accounts for Confluent Cloud.

Method name Action triggering an auditable event message
CreateUser (examples) A request to create a user account.
DeleteUser (examples) A request to delete a user account.
InviteUser (examples) A request to invite a user account.

Examples

CreateUser: Create a user account

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": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-loy67j"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "1567fdc76e352ce41c1f3b5fc6a748a1"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "api_version": "v2",
        "email": "example@confluent.io",
        "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": "example@confluent.io",
        "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: Create a user account – failure (“Error while calling CreateUser”)

DeleteUser: Delete a user account

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": "example@confluent.io",
        "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"
    },
    "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": "example@confluent.io",
        "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"
  }
}

InviteUser: Invite a user

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": "example@confluent.io",
        "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": "example@confluent.io",
          "kind": "User"
        }
      }
    },
    "result": {
      "status": "SUCCESS",
      "data": {
        "user": {
          "api_version": "v2",
          "email": "example@confluent.io",
          "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": "example@confluent.io",
        "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": "example@confluent.io",
          "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": "example@confluent.io",
        "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": "example@confluent.io",
          "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"
  }
}

Connector

Included here are the actions, or operations, on a Confluent Cloud managed connector that generate auditable event messages. For more about managed connectors, see Connect to External Systems.

Method name Action triggering an auditable event message
CreateConnector (examples) A request to create a connector.
CreateOrUpdateConnector (examples) A request to update an existing connector with the provided configuration and, if a connector with the given name doesn’t exist, request to create a connector.
DeleteConnector (examples) A request to delete a connector.
GetConnector (examples) A request for a query of connector details.
GetConnectors (examples) A request for a query of a list of all connectors.
PauseConnector (examples) A request to pause a connector.
ResumeConnector (examples) A result to resume a paused connector.

Examples

CreateConnector: Create a connector

SUCCESS
{
  "specversion": "1.0",
  "id": "ea82b76b-af6f-4dbb-a939-266232a0cc98",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-12j2w5/connector=lcc-pkdrjy",
  "time": "2021-10-20T20:00:56.417826232Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "CreateConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-12j2w5"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-pkdrjy"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "585f36dd2933d0dda8273451476d2fd7"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "redshift-sink-enterprise"
      }
    },
    "result": {
      "status": "SUCCESS",
      "data": {
        "name": "redshift-sink-enterprise",
        "user_configs": {
          "aws.redshift.user": "awsuser",
          "cloud.provider": "aws",
          "input.data.format": "AVRO",
          "kafka.api.key": "****************",
          "name": "redshift-sink-enterprise",
          "aws.redshift.domain": "redshift-cluster-1.us-west-1.redshift.amazonaws.com",
          "db.timezone": "US/Pacific",
          "kafka.region": "us-west-2",
          "topics": "RedshiftSink-connect-pro-1634759921",
          "valid.kafka.api.key": "true",
          "auto.evolve": "false",
          "aws.redshift.database": "dev",
          "aws.redshift.port": "5439",
          "kafka.api.secret": "****************",
          "kafka.dedicated": "false",
          "kafka.endpoint": "SASL_SSL://pkc-12345.us-west-2.aws.confluent.cloud:9092",
          "tasks.max": "1",
          "auto.create": "true",
          "aws.redshift.password": "****************",
          "cloud.environment": "prod",
          "connector.class": "RedshiftSink",
          "internal.kafka.endpoint": "PLAINTEXT://kafka-0.kafka.pkc-12345.svc.cluster.local:9071,kafka-1.kafka.pkc-12345.svc.cluster.local:9071,kafka-2.kafka.pkc-12345.svc.cluster.local:9071"
        },
        "type": 2
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-12j2w5/connector=lcc-pkdrjy"
  }
}
FAILURE ("failed to setup connector ...")
{
  "specversion": "1.0",
  "id": "bb69c825-01bb-47b3-8462-eeb5aa59df1d",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-o3q3zy",
  "time": "2021-10-21T01:10:59.132611387Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "CreateConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            }
          ]
        },
        "resource": {
          "type": "CLOUD_CLUSTER",
          "resourceId": "lkc-o3q3zy"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "9f40e10be8042a21a41c66b811f54a01"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "eventhub-source"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "id": "9f40e10be8042a21a41c66b811f54a01",
            "status": "500",
            "detail": "failed to setup connector: unable to get external connect secret by logical id",
            "source": {}
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-o3q3zy"
  }
}

CreateOrUpdateConnector: Create or update a connector

SUCCESS
{
  "specversion": "1.0",
  "id": "16f7e1ce-683d-435c-8fec-a7dd515497cd",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-gkdn7n",
  "time": "2021-10-20T21:21:15.036414311Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "CreateOrUpdateConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-rrrnk7"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-gkdn7n"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "7ac2c343362fd5234352d1ca02ccd545"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "control-plane"
      }
    },
    "result": {
      "status": "SUCCESS",
      "data": {
        "type": 2,
        "name": "control-plane-pro",
        "user_configs": {
          "connector.class": "S3_SINK",
          "kafka.api.key": "****************",
          "s3.bucket.name": "connect-test",
          "s3.region": "us-west-2",
          "tasks.max": "1",
          "cloud.environment": "prod",
          "internal.kafka.endpoint": "PLAINTEXT://kafka-0.kafka.pkc-12345.svc.cluster.local:9071,kafka-1.kafka.pkc-12345.svc.cluster.local:9071,kafka-2.kafka.pkc-12345.svc.cluster.local:9071",
          "kafka.dedicated": "false",
          "name": "control-plane",
          "input.data.format": "JSON",
          "kafka.endpoint": "SASL_SSL://pkc-12345.us-west-2.aws.confluent.cloud:9092",
          "kafka.region": "us-west-2",
          "output.data.format": "JSON",
          "time.interval": "HOURLY",
          "topics": "connect-pro-semaphore-1634764254",
          "valid.kafka.api.key": "true",
          "aws.access.key.id": "****************",
          "aws.secret.access.key": "****************",
          "cloud.provider": "aws",
          "kafka.api.secret": "****************"
        }
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-gkdn7n"
  }
}
FAILURE ("You already have 3 task(s) of available 32 on your kafka cluster")
{
  "specversion": "1.0",
  "id": "22564e38-19b8-4e6a-8a46-89b33eaa3e61",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-dgdvk1",
  "time": "2021-10-21T06:41:51.968720822Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "CreateOrUpdateConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-rrrnk7"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-dgdvk1"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "ac0b92fa9a9f306f05f00db2b83e3dc0"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "control-plane"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "source": {},
            "id": "ac0b92fa9a9f306f05f00db2b83e3dc0",
            "status": "400",
            "detail": "You have already used 3 task(s) of available 32 on your kafka cluster lkc-rrrnk7. This typically occurs when other connectors are running in your organization. To add more available tasks, contact your Confluent account manager."
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-dgdvk1"
  }
}

DeleteConnector: Delete a connector

SUCCESS
{
  "specversion": "1.0",
  "id": "220a06b2-05ba-4288-b9b7-5724f4c60172",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-ny0p0v/connector=lcc-23orvm",
  "time": "2021-10-21T00:19:02.288866109Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "DeleteConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-ny0p0v"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-23orvm"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "7908028c1da8c0800b1a7f8c3ea1a8a4"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "generate-AzureSqlDwSink-connect-pro-1634774928-AVRO"
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-ny0p0v/connector=lcc-23orvm"
  }
}
FAILURE ("unable to get connector by a given filter ...")
{
  "specversion": "1.0",
  "id": "aa5f89b9-a5d2-4821-9f08-f106c60ccd66",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-q2r2rp",
  "time": "2021-10-20T21:18:08.189486803Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "DeleteConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            }
          ]
        },
        "resource": {
          "type": "CLOUD_CLUSTER",
          "resourceId": "lkc-q2r2rp"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "0d1cd82ac788afd4f0bdc97c77d078b6"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "GoogleCloudFunctionsSink"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "id": "0d1cd82ac788afd4f0bdc97c77d078b6",
            "status": "500",
            "detail": "unable to get connector by a given filter: failed to get logical clusters",
            "source": {}
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-q2r2rp"
  }
}

GetConnector: Get connector details

SUCCESS
{
  "specversion": "1.0",
  "id": "f9e0e4e3-1788-4511-a2f0-64568e4791b3",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-pgrgr5/connector=lcc-3nqrmo",
  "time": "2021-10-20T21:21:31.953972658Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-pgrgr5"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-3nqrmo"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "9ab19ef5908edc9933da05042c8737d3"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY",
      "data": {
        "name": "s3-sink-enterprise"
      }
    },
    "result": {
      "status": "SUCCESS",
      "data": {
        "name": "s3-sink-enterprise",
        "user_configs": {
          "connector.class": "S3_SINK",
          "kafka.endpoint": "SASL_SSL://pkc-12345.us-west-2.aws.confluent.cloud:9092",
          "output.data.format": "JSON",
          "kafka.dedicated": "false",
          "kafka.region": "us-west-2",
          "tasks.max": "1",
          "time.interval": "HOURLY",
          "topics": "S3Sink-connect-pro-1634759921",
          "aws.access.key.id": "****************",
          "aws.secret.access.key": "****************",
          "cloud.provider": "aws",
          "valid.kafka.api.key": "true",
          "s3.bucket.name": "connect-sink",
          "s3.region": "us-west-2",
          "internal.kafka.endpoint": "PLAINTEXT://kafka-0.kafka.pkc-12345.svc.cluster.local:9071,kafka-1.kafka.pkc-12345.svc.cluster.local:9071,kafka-2.kafka.pkc-12345.svc.cluster.local:9071",
          "kafka.api.key": "****************",
          "kafka.api.secret": "****************",
          "cloud.environment": "prod",
          "input.data.format": "JSON",
          "name": "s3-sink-enterprise"
        },
        "type": 2
      }
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-pgrgr5/connector=lcc-3nqrmo"
  }
}
FAILURE ("resource not found")
{
  "specversion": "1.0",
  "id": "2958c204-3e63-4e46-8985-cb980862c894",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=eb537e84-c29b-4dc6-b962-7d094a775204/environment=env-wmwrm/cloud-cluster=lkc-dgrgo1",
  "time": "2021-10-21T06:31:59.366743359Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "eb537e84-c29b-4dc6-b962-7d094a775204"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-wmwrm"
            }
          ]
        },
        "resource": {
          "type": "CLOUD_CLUSTER",
          "resourceId": "lkc-dgrgo1"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-ld8v81"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "1e4b4fb1634700f3e3d617dab4c35bc2"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY",
      "data": {
        "name": "DatagenSourceConnector_0"
      }
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "id": "1e4b4fb1634700f3e3d617dab4c35bc2",
            "status": "404",
            "detail": "resource not found",
            "source": {}
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=eb537e84-c29b-4dc6-b962-7d094a775204/environment=env-wmwrm/cloud-cluster=lkc-dgrgo1"
  }
}

GetConnectors: Get a list of connectors

SUCCESS
{
  "specversion": "1.0",
  "id": "eae9ac01-0868-45a5-82dc-2716f867545c",
  "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/cloud-cluster=lkc-j8d8kp",
  "time": "2021-10-21T08:36:25.686128307Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetConnectors",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "c5e50abf-6ba7-4926-a39c-6008f49f5075"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-knnrw6"
            }
          ]
        },
        "resource": {
          "type": "CLOUD_CLUSTER",
          "resourceId": "lkc-j8d8kp"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-97pp07"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "bc1c7a45805a6a01cab7ac9b91ff8e0a"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY"
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=c5e50abf-6ba7-4926-a39c-6008f49f5075/environment=env-knnrw6/cloud-cluster=lkc-j8d8kp"
  }
}
FAILURE ("Forbidden Access")
{
  "specversion": "1.0",
  "id": "67833661-b4f6-4cdd-a739-baabfc778b15",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/environment=env-81jz3r/cloud-cluster=cc5c2daa-8d58-4284-affa-5e597240d39b",
  "time": "2021-10-20T19:30:28.85498229Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "GetConnectors",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "906da5b6-ebac-44cf-8a8d-663559f1f0d4"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-81jz3r"
            }
          ]
        },
        "resource": {
          "type": "CLOUD_CLUSTER",
          "resourceId": "cc5c2daa-8d58-4284-affa-5e597240d39b"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4xn71e"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "ed7782db0e6e1c0f419ad45698708706"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "READ_ONLY"
    },
    "result": {
      "status": "FAILURE",
      "data": {
        "errors": [
          {
            "code": "forbidden_access",
            "detail": "Forbidden Access",
            "source": {},
            "id": "ed7782db0e6e1c0f419ad45698708706",
            "status": "403"
          }
        ]
      }
    },
    "resourceName": "crn://confluent.cloud/organization=906da5b6-ebac-44cf-8a8d-663559f1f0d4/environment=env-81jz3r/cloud-cluster=cc5c2daa-8d58-4284-affa-5e597240d39b"
  }
}

PauseConnector: Pause a connector

SUCCESS
{
  "specversion": "1.0",
  "id": "7d123481-0431-4256-80eb-0a7c3caa4642",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=be3c4d5d-8d7f-4043-9236-339f7725edd7/environment=env-kyj06/cloud-cluster=lkc-q8d82d/connector=lcc-ygpg3k",
  "time": "2021-10-21T01:50:24.942723289Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "PauseConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "be3c4d5d-8d7f-4043-9236-339f7725edd7"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-kyj06"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-q8d82d"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-ygpg3k"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4v80d0"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "02db11451fb220ccf184dc19d1815e6b"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "DatagenConnector-1634780844"
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=be3c4d5d-8d7f-4043-9236-339f7725edd7/environment=env-kyj06/cloud-cluster=lkc-q8d82d/connector=lcc-ygpg3k"
  }
}

ResumeConnector: Resume a connector

SUCCESS
{
  "specversion": "1.0",
  "id": "afe311ad-3fc8-4085-abe6-d507427d6e80",
  "source": "crn://confluent.cloud/",
  "type": "io.confluent.cloud/request",
  "datacontenttype": "application/json",
  "subject": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-gkdn7n",
  "time": "2021-10-20T21:41:22.01312414Z",
  "data": {
    "serviceName": "crn://confluent.cloud/",
    "methodName": "ResumeConnector",
    "cloudResources": [
      {
        "scope": {
          "resources": [
            {
              "type": "ORGANIZATION",
              "resourceId": "3bd538c6-caa8-42ec-b60b-00bbf2e749f1"
            },
            {
              "type": "ENVIRONMENT",
              "resourceId": "env-8rv9r"
            },
            {
              "type": "CLOUD_CLUSTER",
              "resourceId": "lkc-rrrnk7"
            }
          ]
        },
        "resource": {
          "type": "CONNECTOR",
          "resourceId": "lcc-gkdn7n"
        }
      }
    ],
    "authenticationInfo": {
      "principal": {
        "email": "example@confluent.io",
        "confluentUser": {
          "resourceId": "u-4rxom7"
        }
      },
      "result": "SUCCESS"
    },
    "requestMetadata": {
      "requestId": [
        "961d6482b9cbef069564b31e55356488"
      ],
      "clientAddress": [
        {
          "ip": "1.2.3.4"
        }
      ]
    },
    "request": {
      "accessType": "MODIFICATION",
      "data": {
        "name": "control-plane"
      }
    },
    "result": {
      "status": "SUCCESS"
    },
    "resourceName": "crn://confluent.cloud/organization=3bd538c6-caa8-42ec-b60b-00bbf2e749f1/environment=env-8rv9r/cloud-cluster=lkc-rrrnk7/connector=lcc-gkdn7n"
  }
}