Create Or Update Consumer Associated to a Specific Plugin

PUT {{gateway}}/plugins/:pluginId/consumer

Create Or Update Consumer Associated to a Specific Plugin konghq

  • Inserts (or replaces) the Consumer under the requested resource with the definition specified in the body. The Consumer will be identified via the username or id attribute.
  • When the username or id attribute has the structure of a UUID, the Consumer being inserted/replaced will be identified by its id. Otherwise it will be identified by its username.
  • When creating a new Consumer without specifying id (neither in the URL nor in the body), then it will be auto-generated.
  • Notice that specifying a username in the URL and a different one in the request body is not allowed.
AttributesMandatoryTypeDescription
plugin idrequiredpathThe unique identifier of the Plugin associated to the Consumer to be created or updated.

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-username1", "custom_id"=>"my-custom-id1", "tags"=>["user-level", "low-priority"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring