Confluent Share Group (v3) API
[](#section/Versioning/API-Lifecycle-Policy)
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/confluent-share-group-v3-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Confluent Cloud Share Group (v3) API
version: ''
x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
x-audience: external-public
x-logo:
url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
description: '# Introduction
Note
This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API
tags:
- name: Share Group (v3)
description: ''
paths:
/kafka/v3/clusters/{cluster_id}/share-groups:
servers:
- url: https://pkc-00000.region.provider.confluent.cloud
x-audience: business-unit-internal
description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud
parameters:
- $ref: '#/components/parameters/ClusterId'
get:
summary: List Share Groups
operationId: listKafkaShareGroups
description: '
Return the list of share groups that belong to the specified
Kafka cluster.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'200':
$ref: '#/components/responses/ListShareGroupsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}:
servers:
- url: https://pkc-00000.region.provider.confluent.cloud
x-audience: business-unit-internal
description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud
parameters:
- $ref: '#/components/parameters/ClusterId'
- $ref: '#/components/parameters/GroupId'
get:
summary: Get Share Group
operationId: getKafkaShareGroup
description: '
Return the share group specified by the ``group_id``.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'200':
$ref: '#/components/responses/GetShareGroupResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
delete:
summary: Delete Share Group
operationId: deleteKafkaShareGroup
description: '
Delete the share group specified by the ``group_id``.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'204':
$ref: '#/components/responses/NoContentResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'404':
$ref: '#/components/responses/NotFoundErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers:
servers:
- url: https://pkc-00000.region.provider.confluent.cloud
x-audience: business-unit-internal
description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud
parameters:
- $ref: '#/components/parameters/ClusterId'
- $ref: '#/components/parameters/GroupId'
get:
summary: List Share Group Consumers
operationId: listKafkaShareGroupConsumers
description: '
Return a list of consumers that belong to the specified share
group.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'200':
$ref: '#/components/responses/ListShareGroupConsumersResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}:
servers:
- url: https://pkc-00000.region.provider.confluent.cloud
x-audience: business-unit-internal
description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud
parameters:
- $ref: '#/components/parameters/ClusterId'
- $ref: '#/components/parameters/GroupId'
- $ref: '#/components/parameters/ConsumerId'
get:
summary: Get Share Group Consumer
operationId: getKafkaShareGroupConsumer
description: '
Return the consumer specified by the ``consumer_id``.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'200':
$ref: '#/components/responses/GetShareGroupConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments:
servers:
- url: https://pkc-00000.region.provider.confluent.cloud
x-audience: business-unit-internal
description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud
parameters:
- $ref: '#/components/parameters/ClusterId'
- $ref: '#/components/parameters/GroupId'
- $ref: '#/components/parameters/ConsumerId'
get:
summary: List Share Group Consumer Assignments
operationId: listKafkaShareGroupConsumerAssignments
description: '
Return the consumer assignments specified by the ``consumer_id``.'
tags:
- Share Group (v3)
security:
- resource-api-key: []
- external-access-token: []
responses:
'200':
$ref: '#/components/responses/ListShareGroupConsumerAssignmentsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
components:
schemas:
ShareGroupDataList:
allOf:
- $ref: '#/components/schemas/ResourceCollection'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShareGroupData'
Resource:
type: object
required:
- kind
- metadata
properties:
kind:
type: string
metadata:
$ref: '#/components/schemas/ResourceMetadata'
ResourceCollection:
type: object
required:
- kind
- metadata
properties:
kind:
type: string
metadata:
$ref: '#/components/schemas/ResourceCollectionMetadata'
ShareGroupTopicPartitionData:
allOf:
- $ref: '#/components/schemas/Resource'
- type: object
required:
- topic_name
- partition_id
- partition
properties:
topic_name:
type: string
description: The name of the topic
partition_id:
type: integer
format: int32
description: The partition ID
partition:
$ref: '#/components/schemas/Relationship'
description: Link to the topic partition
ResourceMetadata:
type: object
required:
- self
properties:
self:
type: string
resource_name:
type:
- string
- 'null'
ShareGroupConsumerAssignmentData:
allOf:
- $ref: '#/components/schemas/Resource'
- type: object
required:
- cluster_id
- group_id
- consumer_id
- topic_name
- partition_id
- partition
properties:
cluster_id:
type: string
group_id:
type: string
consumer_id:
type: string
topic_name:
type: string
partition_id:
type: integer
partition:
$ref: '#/components/schemas/Relationship'
ShareGroupConsumerData:
allOf:
- $ref: '#/components/schemas/Resource'
- type: object
required:
- cluster_id
- group_id
- consumer_id
- client_id
- assignments
properties:
cluster_id:
type: string
group_id:
type: string
consumer_id:
type: string
client_id:
type: string
assignments:
$ref: '#/components/schemas/Relationship'
Relationship:
type: object
required:
- related
properties:
related:
type: string
ResourceCollectionMetadata:
type: object
required:
- self
properties:
self:
type: string
next:
type:
- string
- 'null'
ShareGroupState:
type: string
x-extensible-enum:
- UNKNOWN
- PREPARING_REBALANCE
- COMPLETING_REBALANCE
- STABLE
- DEAD
- EMPTY
ShareGroupConsumerAssignmentDataList:
allOf:
- $ref: '#/components/schemas/ResourceCollection'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShareGroupConsumerAssignmentData'
ShareGroupData:
allOf:
- $ref: '#/components/schemas/Resource'
- type: object
required:
- cluster_id
- share_group_id
- state
- coordinator
- consumers
- consumer_count
- partition_count
properties:
cluster_id:
type: string
share_group_id:
type: string
state:
$ref: '#/components/schemas/ShareGroupState'
coordinator:
$ref: '#/components/schemas/Relationship'
consumers:
$ref: '#/components/schemas/Relationship'
consumer_count:
type: integer
format: int32
description: Number of consumers in this share group
partition_count:
type: integer
format: int32
description: Total number of partitions assigned to this share group across all consumers
assigned_topic_partitions:
type: array
items:
$ref: '#/components/schemas/ShareGroupTopicPartitionData'
description: List of topic-partitions assigned to this share group, including those from empty groups
ShareGroupConsumerDataList:
allOf:
- $ref: '#/components/schemas/ResourceCollection'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShareGroupConsumerData'
Error:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type:
- string
- 'null'
additionalProperties: false
responses:
ListShareGroupConsumersResponse:
description: The list of consumers.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareGroupConsumerDataList'
example:
kind: KafkaShareConsumerList
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers
next: null
data:
- kind: KafkaShareGroupConsumer
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-1
client_id: client-1
assignments:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments
- kind: KafkaShareGroupConsumer
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-2
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-2
client_id: client-2
assignments:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-2/assignments
- kind: KafkaShareGroupConsumer
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-3
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-3
client_id: client-3
assignments:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-3/assignments
UnauthorizedErrorResponse:
description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
kafka_authentication_failed:
description: Thrown when using Basic authentication with wrong Kafka credentials.
value:
error_code: 40101
message: Authentication failed
NotFoundErrorResponse:
description: Indicates attempted access to an unreachable or non-existing resource like e.g. an unknown topic or partition. GET requests to endpoints not allowed in the accesslists will also result in this response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
endpoint_not_found:
description: Thrown for generic HTTP 404 errors.
value:
error_code: 404
message: HTTP 404 Not Found
cluster_not_found:
description: Thrown when using a non-existing cluster ID.
value:
error_code: 404
message: Cluster my-cluster cannot be found.
unknown_topic_or_partition:
description: Thrown when using a non-existing topic name or partition ID.
value:
error_code: 40403
message: This server does not host this topic-partition.
ListShareGroupConsumerAssignmentsResponse:
description: The list of share group assignments.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareGroupConsumerAssignmentDataList'
example:
kind: KafkaConsumerAssignmentList
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments
next: null
data:
- kind: KafkaShareGroupConsumerAssignment
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-1/partitions/1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=1/partition=1
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-1
topic_name: topic-1
partition_id: 1
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
- kind: KafkaShareGroupConsumerAssignment
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-2/partitions/2
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=2/partition=2
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-1
topic_name: topic-2
partition_id: 2
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/2
- kind: KafkaShareGroupConsumerAssignment
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments/topic-3/partitions/3
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1/assignment=topic=3/partition=3
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-1
topic_name: topic-3
partition_id: 3
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/3
NoContentResponse:
description: Operation succeeded, no content in the response
BadRequestErrorResponse:
description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
bad_request_cannot_deserialize:
description: Thrown when trying to deserialize an integer from non-integer data.
value:
error_code: 400
message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value'
unsupported_version_exception:
description: Thrown when the version of this API is not supported in the underlying Kafka cluster.
value:
error_code: 40035
message: The version of this API is not supported in the underlying Kafka cluster.
ServerErrorResponse:
description: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
generic_internal_server_error:
description: Thrown for generic HTTP 500 errors.
value:
error_code: 500
message: Internal Server Error
ForbiddenErrorResponse:
description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
kafka_authorization_failed:
description: Thrown when the caller is not authorized to perform the underlying operation.
value:
error_code: 40301
message: Request is not authorized
TooManyRequestsErrorResponse:
description: Indicates that a rate limit threshold has been reached, and the client should retry again later.
content:
text/html:
schema:
type: string
example:
description: A sample response from Jetty's DoSFilter.
value: <html> <head> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> <title>Error 429 Too Many Requests</title> </head> <body> <h2>HTTP ERROR 429 Too Many Requests</h2> <table> <tr> <th>URI:</th> <td>/v3/clusters/my-cluster</td> </tr> <tr> <th>STATUS:</th> <td>429</td> </tr> <tr> <th>MESSAGE:</th> <td>Too Many Requests</td> </tr> <tr> <th>SERVLET:</th> <td>default</td> </tr> </table> </body> </html>
ListShareGroupsResponse:
description: The list of share groups.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareGroupDataList'
example:
kind: KafkaShareGroupList
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups
next: null
data:
- kind: KafkaShareGroup
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1
cluster_id: cluster-1
share_group_id: share-group-1
state: STABLE
coordinator:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
consumers:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers
consumer_count: 2
partition_count: 3
assigned_topic_partitions:
- kind: KafkaShareGroupTopicPartition
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0
topic_name: topic-1
partition_id: 0
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0
- kind: KafkaShareGroup
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2
resource_name: crn:///kafka=cluster-1/share-group=share-group-2
cluster_id: cluster-1
share_group_id: share-group-2
state: EMPTY
coordinator:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2
consumers:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/consumers
consumer_count: 2
partition_count: 3
assigned_topic_partitions:
- kind: KafkaShareGroupTopicPartition
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-2/assigned-topic-partitions/topic-1/0
resource_name: crn:///kafka=cluster-1/share-group=share-group-2/topic-partition=topic-1:0
topic_name: topic-1
partition_id: 0
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0
GetShareGroupResponse:
description: The share group.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareGroupData'
example:
kind: KafkaShareGroup
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1
cluster_id: cluster-1
share_group_id: share-group-1
state: STABLE
coordinator:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
consumers:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers
consumer_count: 2
partition_count: 3
assigned_topic_partitions:
- kind: KafkaShareGroupTopicPartition
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/0
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:0
topic_name: topic-1
partition_id: 0
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/0
- kind: KafkaShareGroupTopicPartition
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/assigned-topic-partitions/topic-1/1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/topic-partition=topic-1:1
topic_name: topic-1
partition_id: 1
partition:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
GetShareGroupConsumerResponse:
description: The consumer.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareGroupConsumerData'
example:
kind: KafkaShareGroupConsumer
metadata:
self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1
resource_name: crn:///kafka=cluster-1/share-group=share-group-1/consumer=consumer-1
cluster_id: cluster-1
group_id: share-group-1
consumer_id: consumer-1
client_id: client-1
assignments:
related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/share-groups/share-group-1/consumers/consumer-1/assignments
parameters:
ClusterId:
name: cluster_id
description: The Kafka cluster ID.
in: path
required: true
schema:
type: string
example: cluster-1
GroupId:
name: group_id
description: The group ID.
in: path
required: true
schema:
type: string
example: group-1
ConsumerId:
name: consumer_id
description: The consumer ID.
in: path
required: true
schema:
type: string
example: consumer-1
securitySchemes:
cloud-api-key:
type: http
scheme: basic
description: Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
confluent-sts-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
global-api-key:
type: http
scheme: basic
description: Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
resource-api-key:
type: http
scheme: basic
description: Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret as the password.
external-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
oauth:
type: oauth2
description: Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.
flows:
clientCredentials:
tokenUrl: /oauth2/token
scopes:
partner:alter: enables partners to alter entitlements
partner:create: enables partners to create entitlements and signup on behalf of customers
partner:delete: enables partners to delete entitlements and organizations
partner:describe: enables partners to read and list entitlements and organizations
x-tagGroups:
- name: Identity Access Management (v2)
tags:
- API Keys (iam/v2)
- Users (iam/v2)
- Service Accounts (iam/v2)
- Invitations (iam/v2)
- IP Groups (iam/v2)
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/openapi/confluent-share-group-v3-api-openapi.yml