Create Consumer

POST {{gateway}}/consumers

Create Consumer konghq

Request Body

AttributesMandatoryDescription
usernamesemi-optionalThe unique username of the consumer. You must send either this field or custom_id with the request.
custom_idsemi-optionalField for storing an existing unique ID for the consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.
tagsoptionalAn optional set of strings associated with the Consumer, for grouping and filtering.

Request Body

{"username"=>"my-username", "custom_id"=>"my-custom-id", "tags"=>["user-level", "low-priority"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{"custom_id":"my-custom-id","created_at":1583991173,"id":"626169e4-6cd7-4952-85b1-3fda70fd5333","tags":["user-level","low-priority"],"username":"my-username"}