Service doublecloud.kafka.v1.UserService

Get

Returns the specified Apache Kafka User resource.

To get the list of available Apache Kafka User resources, make a [List] request.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the Apache Kafka User resource to return. To get the name of the user, use a [UserService.List] request.

Response

Field	Description
`name`	string Apache Kafka User's name. For a string spec see [UserSpec.name]
`cluster_id`	string Apache Kafka cluster ID the user belongs to.
`permissions`	list Set of permissions the user is granted with.
`permissions[]`	doublecloud.kafka.v1.Permission

List

Retrieves the list of Apache Kafka User resources for the specified cluster.

Request

Field

Description

cluster_id

string Required. ID of the cluster to list Apache Kafka users in. To get the cluster ID, use a [ClusterService.List] request.

paging

doublecloud.v1.Paging Paging information of the request. See [doublecloud.priv.v1.Paging] for details

Following constraints applied:

page_size will be set to 1000 items when exceeded
page_size expected to be >= 0
default page_size is 100

Response

Field	Description
`users`	list List of Apache Kafka User resources.
`users[]`	doublecloud.kafka.v1.User
`next_page`	doublecloud.v1.NextPage Pagination information of the response See [doublecloud.priv.v1.NextPage] for details

Create

Creates an Apache Kafka User on the specified cluster.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster to create a user in. To get the cluster ID, use a [ClusterService.List] request.
`user_spec`	doublecloud.kafka.v1.UserSpec User creation payload. See [UserSpec] for details

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Updates the specified Apache Kafka User.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to be updated. To get the name of the user use a [UserService.List] request.
`update_spec`	doublecloud.kafka.v1.UpdateUserRequest.UpdateSpec Defines which exact attributes to be updated.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Deletes the specified Apache Kafka User.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to delete. To get the name of the user, use a [UserService.List] request.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

GrantPermission

Grants permission to the specified Apache Kafka User.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to grant the permission to. To get the name of the user, use a [UserService.List] request.
`permission`	doublecloud.kafka.v1.Permission Required. Permission that should be granted to the specified user.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

RevokePermission

Revokes permission from the specified Apache Kafka User.

Request

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to revoke a permission from. To get the name of the user, use a [UserService.List] request.
`permission`	doublecloud.kafka.v1.Permission Required. Permission that should be revoked from the specified user.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

TopicService

VersionService