-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for
kong_consumer_key_auth
- Loading branch information
1 parent
01bd7c2
commit 2b14ef2
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |