From 07e519f1ac3158231c20627056c4e9771372137b Mon Sep 17 00:00:00 2001 From: Flo Date: Wed, 3 Apr 2024 21:15:55 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20API=20key=20authentic?= =?UTF-8?q?ation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/index.md | 9 +++++++++ examples/provider/provider.tf | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/docs/index.md b/docs/index.md index ff421de..6d9cdc5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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@address.com" password = "password" + + # ...or using an API key. + # api_key = "API key" } ``` @@ -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. diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index f0efecf..a583c84 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -1,5 +1,10 @@ provider "metabase" { endpoint = "http://metabase-endpoint.com/api" + + # Authentication can be done using a username and password... username = "email@address.com" password = "password" + + # ...or using an API key. + # api_key = "API key" }