Getting Started - Documentation - Confluent Self-Service

Welcome

Welcome to the Confluent Self-Service portal! This application provides a secure, multi-tenant interface for managing your Kafka resources in Confluent Cloud — including Topics, Connectors, Schemas, Service Accounts, and Identity Pools.

Before you can start managing resources, you'll need to set your Context (Business Unit and Stage). The details for your context are provided to you by the E.ON Platform Team. If you haven't received this information yet, please reach out to brain-platform@eon.com.

Setting Context

The Context determines which Kafka environment you are working with. It consists of two fields:

Business Unit

Your business unit identifier (e.g., scada). This is provided to you by the E.ON Platform Team and determines which Kafka cluster and resources you have access to.

Stage

The environment stage you want to work in. Available stages are:

dev — Development environment
qas — Quality Assurance / Staging environment
run — Production environment

You can find the Context selector at the bottom of the sidebar on the left. Enter your Business Unit and select your Stage to get started.

When the context has changed but the page data has not yet been refreshed, a small dot will appear on the Reload button to indicate that the context still needs to be reloaded. See the next section for more details on auto and manual reload behaviour.

Using Context

Once your context is set, the portal will use it to load your resources (topics, connectors, schemas, service accounts, identity pools) from the correct Kafka environment. There are two ways the context can refresh data on the page:

Auto Reload (enabled by default)

When the Auto reload checkbox is checked, any change you make to the Business Unit or Stage will immediately refresh the page data. This is the default behaviour.

Manual Reload

If you uncheck Auto reload, changing the context will not automatically refresh the page. Instead, a small indicator dot will appear on the Reload button to show that the context has changed. Click the Reload button when you are ready to load data for the new context.

Tip

Your context is stored in your browser's local storage. It will persist across sessions, so you only need to set it once per browser.

Breadcrumbs

Throughout the portal, you'll see a breadcrumb navigation bar near the top of each page. The breadcrumbs show your current location and the context you're working in.

Example breadcrumb:

Each segment of the breadcrumb represents:

Home — the home icon links back to the portal home page.

Resource type — the type of resource you're viewing (e.g., topics, connectors, schemas, service-accounts, or identity-pools).

Business Unit — your business unit identifier from the current context.

Stage — the environment stage (dev, qas, or run).

Note

For shared clusters, an additional Landing Zone segment may appear between the resource type and the business unit, indicating the shared cluster your business unit belongs to.

Read-Only Environments

Some environments may be configured as read-only. This is typically the case for production (run) environments, where changes are restricted to protect live workloads.

What you can do in a read-only environment

View topics, connectors, schemas, service accounts, and identity pools
Browse topic configurations and connector settings
View cluster and topic metrics

What is restricted

Creating new topics, connectors, schemas, service accounts, or identity pools
Updating existing resource configurations
Deleting resources

When you navigate to a list page (Topics, Connectors, Schemas, Service Accounts, or Identity Pools) in a read-only environment, a banner will appear at the top of the page to let you know:

Example banner:

While this banner is visible, create, edit, and delete controls will be disabled or hidden. API requests that attempt to modify resources will receive a 403 Forbidden response.

Tip

If you need to make changes to a read-only environment, contact the E.ON Platform Team at brain-platform@eon.com.

Authorization Issues

If you encounter a "Not Authorized" error when trying to access resources, it means your user account is not a member of the required Microsoft Entra ID group for the selected business unit.

How authorization works

Access to resources is managed through Entra ID security groups. Each business unit has a dedicated group that controls who can view and manage its resources.

You must be a member of the configured Entra Group for your business unit.
Group membership is managed by the E.ON Platform Team.
If you need access to a different business unit, contact the Platform Team to be added to the appropriate group.

Tip

After being added to a group, you may need to sign out and sign back in for the changes to take effect. Your group memberships are read from your authentication token.

RESTful API

In addition to the web interface, the Confluent Self-Service portal exposes a RESTful API that you can use to manage your Kafka resources programmatically. This is useful for automation, CI/CD pipelines, and integrating with other tools.

Full interactive API documentation is available via the Swagger UI, where you can explore all available endpoints, view request and response schemas, and try out API calls directly.

Endpoint Structure

All resource endpoints follow the same URL pattern:

/{business_unit}/{stage}/{resource}

Where business_unit is your business unit identifier, stage is the environment (dev, qas, or run), and resource is the type of resource (e.g., topics, connectors, schemas, service-accounts, identity-pools).

Resource	Endpoints	Operations
Topics	/{bu}/{stage}/topics /{bu}/{stage}/topic/{name}	List, Get, Create, Update, Delete
Connectors	/{bu}/{stage}/connectors /{bu}/{stage}/connector/{name}	List, Get, Create, Update, Delete, Pause, Resume, Restart
Schemas	/{bu}/{stage}/schemas /{bu}/{stage}/schema/{subject}/{version}	List, Get, Create, Update, Delete
Service Accounts	/{bu}/{stage}/service-accounts /{bu}/{stage}/service-account/{id}	List, Get, Create, Bulk Create
Identity Pools	/{bu}/{stage}/identity-pools /{bu}/{stage}/identity-pool/{id}	List, Get, Create, Update Filter, Delete

Authentication

The API uses OAuth2 with Microsoft Entra ID. To authenticate your API requests, you need to obtain an access token and include it in the Authorization header.

Option 1: Swagger UI (interactive)

The easiest way to get started is via the Swagger UI:

Open the Swagger UI at /api-docs
Click the Authorize button at the top of the page
Sign in with your E.ON Microsoft account
Once authenticated, you can try out any endpoint directly from the browser

Option 2: Obtain a token via Azure CLI

If you have the Azure CLI installed, you can obtain a token for use in scripts and tools:

# Sign in (if not already)
az login

# Get an access token for the Self-Service API
az account get-access-token \
  --resource api://<APP_CLIENT_ID> \
  --query accessToken -o tsv

The APP_CLIENT_ID for your environment will be provided by the E.ON Platform Team.

Example API Calls

Once you have an access token, include it in the Authorization header as a Bearer token. Here are some examples using curl:

List all topics:

curl -X GET "https://<host>/scada/dev/topics" \
  -H "Authorization: Bearer $TOKEN"

Create a new topic:

curl -X POST "https://<host>/scada/dev/topic" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-events",
    "partitions_count": 3,
    "config": {
      "retention.ms": "604800000"
    }
  }'

Get a connector's details:

curl -X GET "https://<host>/scada/dev/connector/my-sink?show_config=true" \
  -H "Authorization: Bearer $TOKEN"

List schemas (latest versions only):

curl -X GET "https://<host>/scada/dev/schemas?latest_only=true" \
  -H "Authorization: Bearer $TOKEN"

List service accounts:

curl -X GET "https://<host>/scada/dev/service-accounts" \
  -H "Authorization: Bearer $TOKEN"

List identity pools:

curl -X GET "https://<host>/scada/dev/identity-pools" \
  -H "Authorization: Bearer $TOKEN"

Tip

Replace <host> with the portal URL provided to you by the E.ON Platform Team.

Contact

If you have any questions, need access to a business unit, or require assistance with the portal, please contact the E.ON BRAIN Platform Team. You can find our contact details in the footer of every page.