Skip to content

Commit

Permalink
📝 Document API key authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
flovouin committed Apr 3, 2024
1 parent fdd3457 commit 07e519f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ While most Terraform resources fully define the Metabase objects using attribute
```terraform
provider "metabase" {
endpoint = "http://metabase-endpoint.com/api"
# Authentication can be done using a username and password...
username = "[email protected]"
password = "password"
# ...or using an API key.
# api_key = "API key"
}
```

Expand All @@ -29,5 +34,9 @@ provider "metabase" {
### Required

- `endpoint` (String) The URL to the Metabase API.

### Optional

- `api_key` (String, Sensitive) The API key to use to authenticate. This can be used instead of a user name and password.
- `password` (String, Sensitive) The password to use to authenticate.
- `username` (String) The user name (or email address) to use to authenticate.
5 changes: 5 additions & 0 deletions examples/provider/provider.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
provider "metabase" {
endpoint = "http://metabase-endpoint.com/api"

# Authentication can be done using a username and password...
username = "[email protected]"
password = "password"

# ...or using an API key.
# api_key = "API key"
}

0 comments on commit 07e519f

Please sign in to comment.