{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Consumers API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Consumers", "type": "folder" }, "items": [ { "info": { "name": "Create a new Consumer", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumers", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The name of the workspace" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Consumer" }, { "info": { "name": "Get a Consumer", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumers/:ConsumerIdOrUsername", "params": [ { "name": "ConsumerIdOrUsername", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID or username of the Consumer to lookup" }, { "name": "workspace", "value": "", "type": "path", "description": "The name of the workspace" } ] }, "docs": "Get a Consumer using ID or username." }, { "info": { "name": "Upsert a Consumer", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumers/:ConsumerIdOrUsername", "params": [ { "name": "ConsumerIdOrUsername", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID or username of the Consumer to lookup" }, { "name": "workspace", "value": "", "type": "path", "description": "The name of the workspace" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update Consumer using ID or username." }, { "info": { "name": "Delete a Consumer", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumers/:ConsumerIdOrUsername", "params": [ { "name": "ConsumerIdOrUsername", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID or username of the Consumer to lookup" }, { "name": "workspace", "value": "", "type": "path", "description": "The name of the workspace" } ] }, "docs": "Delete a Consumer" }, { "info": { "name": "List all Consumers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "size", "value": "", "type": "query", "description": "Number of resources to be returned." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources" }, { "name": "tags", "value": "tag1,tag2", "type": "query", "description": "A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR." }, { "name": "custom_id", "value": "my-custom-id", "type": "query", "description": "Filter consumers by their custom_id." }, { "name": "filter[name][contains]", "value": "john", "type": "query", "description": "Filter routes by a substring of the name." }, { "name": "filter[name][eq]", "value": "john", "type": "query", "description": "Filter routes by their name." } ] }, "docs": "List all Consumers" }, { "info": { "name": "Create a new Consumer", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Consumer" }, { "info": { "name": "Get a Consumer", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId", "params": [ { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" }, { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." } ] }, "docs": "Get a Consumer using ID or username." }, { "info": { "name": "Upsert a Consumer", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId", "params": [ { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" }, { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update Consumer using ID or username." }, { "info": { "name": "Delete a Consumer", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId", "params": [ { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" }, { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." } ] }, "docs": "Delete a Consumer" }, { "info": { "name": "List all Consumer Groups a Consumer belongs to", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId/consumer_groups", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" }, { "name": "size", "value": "", "type": "query", "description": "Number of resources to be returned." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources" }, { "name": "tags", "value": "tag1,tag2", "type": "query", "description": "A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR." } ] }, "docs": "List all Consumer Groups a Consumer belongs to" }, { "info": { "name": "Add consumer to a specific consumer group", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId/consumer_groups", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a consumer to a consumer group" }, { "info": { "name": "Remove consumer from all consumer groups", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId/consumer_groups", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" } ] }, "docs": "Removes a consumer from all Consumer Groups. This operation does not delete the consumer group." }, { "info": { "name": "Remove consumer from consumer group", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumers/:ConsumerId/consumer_groups/:ConsumerGroupId", "params": [ { "name": "controlPlaneId", "value": "", "type": "path", "description": "The UUID of your control plane. This variable is available in the Konnect manager." }, { "name": "ConsumerId", "value": "c1059869-6fa7-4329-a5f5-5946d14ca2c5", "type": "path", "description": "ID of the Consumer to lookup" }, { "name": "ConsumerGroupId", "value": "", "type": "path", "description": "ID of the Consumer Group to lookup" } ] }, "docs": "Removes a consumer from a Consumer Group. This operation does not delete the consumer group." } ] } ], "bundled": true }