Bundle User

Operations related to users in a bundle.

Get a list of bundle users

Retrieve a list of bundle users currently enabled in the given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
bundle
required
string
Example: kafka
Responses
200

Successfully returned a JSON list of bundle users

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

503

Service Unavailable

504

Gateway Timeout

get/provisioning/v1/{clusterId}/{bundle}/users
Request samples
Response samples
application/json
[
  • "ickafka"
]

Add a bundle user

Add a new bundle user to the given cluster with read write access to all topics

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
bundle
required
string
Example: kafka
Request Body schema: application/json
username
required
string [ 1 .. 255 ] characters
password
required
string [ 8 .. 2147483647 ] characters

Bundle user password

options
object

A collection of optional bundle-specific user options - the options available to be set differ depending on the bundle type.

BundleOptionAllowable values
Kafka"sasl-scram-mechanism""SCRAM-SHA-256" (Default), "SCRAM-SHA-512"
Kafka"override-existing-user"true (Default), false
initial-permissions
string

Permissions upon user creation

Enum: "standard" "read-only" "none"
Responses
201

Bundle user successfully created

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

503

Service Unavailable

504

Gateway Timeout

post/provisioning/v1/{clusterId}/{bundle}/users
Request samples
application/json
{
  • "username": "yourUserName",
  • "password": "yourPassword",
  • "options": {
    },
  • "initial-permissions": "standard"
}
Response samples
application/json
{
  • "message": "User test1 created."
}

Delete a bundle user

Delete bundle user for a given username

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
bundle
required
string
Example: kafka
Request Body schema: application/json
username
required
string [ 1 .. 255 ] characters
Responses
200

Bundle user successfully deleted

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

503

Service Unavailable

504

Gateway Timeout

delete/provisioning/v1/{clusterId}/{bundle}/users
Request samples
application/json
{
  • "username": "yourUserName"
}
Response samples
application/json
{
  • "message": "User test1 has been deleted."
}

Change bundle user password

Reset bundle user password for a given username

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
bundle
required
string
Example: kafka
Request Body schema: application/json
username
required
string [ 1 .. 255 ] characters
password
required
string [ 8 .. 2147483647 ] characters

Password to apply

options
object

A collection of optional bundle-specific user options - the options available to be set differ depending on the bundle type.

BundleOptionAllowable values
Kafka"sasl-scram-mechanism""SCRAM-SHA-256" (Default), "SCRAM-SHA-512"
Responses
200

Password successfully reset

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

503

Service Unavailable

504

Gateway Timeout

post/provisioning/v1/{clusterId}/{bundle}/users/reset-password
Request samples
application/json
{
  • "username": "yourUserName",
  • "password": "yourNewPassword",
  • "options": {
    }
}
Response samples
application/json
{
  • "message": "Updated password for user test1."
}