Ctrl+K

Check batching password flow

get/api/v2/user/checkBatchingPasswordFlow

Checks whether the batching user change password flow is enabled based on payload size.

Query Parameters

  • payloadSizestringRequired
    The payload size in KB
    Example: 500

200 Response

isBatchingFlowEnabled boolean required
Whether the batching flow is enabled
Example: true
maxBatchSizeKB number
Maximum batch size in KB
Example: 900
noOfBatches number required
Number of batches required
Example: 5

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id