Skip to content

Commit

Permalink
Add documentation for kong_consumer_key_auth
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-bulford-form3 committed Oct 8, 2021
1 parent 01bd7c2 commit 2b14ef2
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/resources/consumer_key_auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# kong_consumer_key_auth

Resource that allows you to configure the [Key Authentication](https://docs.konghq.com/hub/kong-inc/key-auth/) plugin for a consumer.

## Example Usage

```hcl
resource "kong_consumer" "my_consumer" {
username = "User1"
custom_id = "123"
}
resource "kong_plugin" "key_auth_plugin" {
name = "key-auth"
}
resource "kong_consumer_key_auth" "consumer_key_auth" {
consumer_id = kong_consumer.my_consumer.id
key = "secret"
tags = ["myTag", "anotherTag"]
}
```

## Argument Reference

* `consumer_id` - (Required) the id of the consumer to associate the credentials to
* `key` - (Optional) Unique key to authenticate the client; if omitted the plugin will generate one
* `tags` - (Optional) A list of strings associated with the consumer key auth for grouping and filtering

0 comments on commit 2b14ef2

Please sign in to comment.