cli_gateway-service-account_gateway_v2_10

POST /gateway/v2/service-account/{vcluster}/{name}/scramcredential/{login}

Generally Available

Add a SCRAM credential to a service account.

The Gateway derives the verifier from the supplied password and stores only the verifier (salt, stored key, server key) — never the clear password. The login is the SASL username the client presents at handshake and must be globally unique across all virtual clusters.

Note: This endpoint requires the service accounts feature flag to be enabled. Set GATEWAY_FEATURE_FLAGS_SERVICE_ACCOUNTS=true to enable this feature.

Request

Path parameters

vclusterstring required
namestring required
loginstring required

Request body

passwordstring required

The clear password to derive the SCRAM verifier from. Never stored or logged.

algorithm'SHA-512' | 'SHA-256'

SCRAM hash algorithm. Defaults to SHA-512.

iterationCountinteger

Hash iteration count, between 4096 (the RFC 5802 minimum, also the default) and 16384 (Kafka's maximum).

Response

loginstring required

The globally unique SCRAM login (the SASL username the client presents).

algorithm'SHA-512' | 'SHA-256' required

SCRAM hash algorithm.

iterationCountinteger required

Hash iteration count.

Changes

No recorded changes to this operation across all 1 revision of this API.