Skip to content
Brokerium

Create or update a SCRAM credential

POST
/api/v1/clusters/{id}/scram-users
curl --request POST \
  --url http://localhost:8080/api/v1/clusters/example/scram-users \
  --header 'Content-Type: application/json' \
  --header 'X-Brokerium-Request: 1' \
  --cookie brokerium_session=<brokerium_session> \
  --data '{ "user": "example", "mechanism": "SCRAM-SHA-256", "password": "example", "iterations": 1 }'

Role: operator.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
X-Brokerium-Request
required
string
Allowed value: 1

Required on every non-GET request.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
user
required
string
mechanism
required
string
Allowed values: SCRAM-SHA-256 SCRAM-SHA-512
password
required
string format: password
iterations
integer format: int32
>= 4096

Responses

Section titled “Responses”

201

Section titled “201”

Saved.

400

Section titled “400”

Error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.