Skip to content

Commit bab99cf

Browse files
committed
chore(docs): Add command config example to Azure auth provider docs.
1 parent fb3992a commit bab99cf

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/auth_providers.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
What is an `auth provider` in the conext of `kfutil`? It's a way to source credentials needed to connect to a Keyfactor
33
product or service from a secure location rather than a file on disk or environment variables.
44

5+
* [Available Auth Providers](#available-auth-providers)
6+
* [Azure Key Vault](#azure-key-vault)
7+
+ [Configuration](#configuration)
8+
+ [Azure Key Vault Secret Format](#azure-key-vault-secret-format)
9+
- [Usage](#usage)
10+
* [Default](#default)
11+
* [Explicit](#explicit)
12+
513
## Available Auth Providers
614
- [Azure Key Vault](#azure-key-vault)
715

@@ -28,6 +36,23 @@ file and will be used by `kfutil` to source credentials for the Keyfactor produc
2836
}
2937
}
3038
```
39+
40+
### Azure Key Vault Secret Format
41+
The format of the Azure Key Vault secret should be the same as if you were to run `kfutil login` and go through the
42+
interactive auth flow. Here's an example of what that would look like:
43+
```json
44+
{
45+
"servers": {
46+
"default": {
47+
"host": "my.kfcommand.domain",
48+
"username": "my_kfcommand_username",
49+
"password": "my_kfcommand_password",
50+
"domain": "my_kfcommand_domain",
51+
"api_path": "KeyfactorAPI"
52+
}
53+
}
54+
}
55+
```
3156
#### Usage
3257

3358
##### Default
@@ -47,3 +72,6 @@ kfutil \
4772
--config /path/to/config/file.json \
4873
stores list
4974
```
75+
The above explicitly tells the utility to only attempt to use the Azure Key Vault auth provider. This mode will not fail
76+
to user interactive or environmental variable auth if provided. The example also shows how to specify a custom path to
77+
the auth provider configuration file and what profile to look for in the configuration file stored in Azure.

0 commit comments

Comments
 (0)