📝 Update providers authentication docs

Signed-off-by: Salim Afiune Maya <[email protected]>
mondoohq · Oct 21, 2024 · ed5bcee · ed5bcee
1 parent 456dfc1
commit ed5bcee
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -27,7 +27,18 @@ provider "mondoo" {
 
 ## Authentication
 
-By default, the provider will use the Mondoo CLI configuration file to authenticate to the Mondoo Platform. The CLI configuration file is located at `~/.config/mondoo/mondoo.yml` on Linux and macOS, and `%HomePath%\mondoo\mondoo.yml` on Windows.
+To configure the Mondoo provider you will need a service account with **Editor** permissions, to create a service
+account, see [Create and Manage Service Accounts](https://mondoo.com/docs/platform/maintain/access/service_accounts/).
+
+By default, the provider will use the Mondoo CLI configuration file to authenticate to the Mondoo Platform. The CLI
+configuration file is located at `~/.config/mondoo/mondoo.yml` on Linux and macOS, and `%HomePath%\mondoo\mondoo.yml`
+on Windows.
+
+You can alternatively use the `credentials` field, or any of the following environment variables ordered by precedence.
+
+* `MONDOO_CONFIG_BASE64`
+* `MONDOO_CONFIG_PATH`
+* `MONDOO_API_TOKEN`
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -16,6 +16,17 @@ The Mondoo provider is used to configure your Mondoo Platform infrastructure.
 
 ## Authentication
 
-By default, the provider will use the Mondoo CLI configuration file to authenticate to the Mondoo Platform. The CLI configuration file is located at `~/.config/mondoo/mondoo.yml` on Linux and macOS, and `%HomePath%\mondoo\mondoo.yml` on Windows.
+To configure the Mondoo provider you will need a service account with **Editor** permissions, to create a service
+account, see [Create and Manage Service Accounts](https://mondoo.com/docs/platform/maintain/access/service_accounts/).
 
-{{ .SchemaMarkdown | trimspace }}
+By default, the provider will use the Mondoo CLI configuration file to authenticate to the Mondoo Platform. The CLI
+configuration file is located at `~/.config/mondoo/mondoo.yml` on Linux and macOS, and `%HomePath%\mondoo\mondoo.yml`
+on Windows.
+
+You can alternatively use the `credentials` field, or any of the following environment variables ordered by precedence.
+
+* `MONDOO_CONFIG_BASE64`
+* `MONDOO_CONFIG_PATH`
+* `MONDOO_API_TOKEN`
+
+{{ .SchemaMarkdown | trimspace }}