Groups

You can view, modify, delete, and create a user group. The commands for these actions are shown in the table below.

Commands	Description
`clone`	Clone a group
`create`	Create a new group
`delete`	Delete a group
`get`	Get specific group by provided name
`update`	Update a group

View groups

List currently user groups.

lenses-cli groups

View group

Get the details of a user group:

lenses-cli groups get --name [GROUPNAME]

Get the assigned data namespaces of a user group:

lenses-cli groups get --name [GROUPNAME] --dataNamespaces

Create

Create a user group via the command line flags or file:

lenses-cli groups create \
    --name MyGroup \
    --description "My test group" \
    --applicationPermissions ViewKafkaConsumers \
    --applicationPermissions ManageKafkaConsumers \
    --applicationPermissions ViewConnectors \
    --connectClustersPermissions dev \
    --dataNamespaces '[{"wildcards":["*"],"permissions":["CreateTopic","DropTopic","ConfigureTopic","QueryTopic","ShowTopic","ViewSchema","InsertData","DeleteData","UpdateSchema"],"system":"Kafka","instance":"Dev", "connection":"kafka"}]'

You can create a user group using a file with the group specifications

lenses-cli groups create ./group.yaml

Example file

name: MyGroup
description: "My test group"
applicationPermissions:
  - ViewKafkaConsumers
  - ManageKafkaConsumers
  - ViewConnectors
connectClustersPermissions:
  - dev
dataNamespaces:
  - wildcards:
      - "*"
    permissions:
      - CreateTopic
      - DropTopic
      - ConfigureTopic
      - QueryTopic
      - ShowTopic
      - ViewSchema
      - InsertData
      - DeleteData
      - UpdateSchema
    system: Kafka
    instance: Dev
    connection: kafka

Update

Update a user group:

lenses-cli groups update \
    --name MyGroup \
    --description "My test group" \
    --applicationPermissions ViewKafkaConsumers \
    --applicationPermissions ManageKafkaConsumers \
    --applicationPermissions ViewConnectors \
    --connectClustersPermissions dev \
    --dataNamespaces '[{"wildcards":["*"],"permissions":["CreateTopic","RequestTopicCreation", "DropTopic","ConfigureTopic","QueryTopic","ShowTopic","InsertData","DeleteData","UpdateSchema","ViewSchema"],"system":"Kafka","instance":"Dev", "connection":"kafka"}]'

Delete

Delete a user group:

lenses-cli groups delete --name [GROUPNAME]

Clone

Clone a user group:

lenses-cli groups clone --name [GROUPNAME] --cloneName [CLONED_GROUPNAME]

Last modified: July 26, 2024