Skip to content

Commit 865ddbd

Browse files
committed
chore(docs): Update auth_providers.md with oauth example.
Signed-off-by: spbsoluble <[email protected]>
1 parent f258ec1 commit 865ddbd

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

docs/auth_providers.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Auth Providers
2-
What is an `auth provider` in the conext of `kfutil`? It's a way to source credentials needed to connect to a Keyfactor
3-
product or service from a secure location rather than a file on disk or environment variables.
2+
3+
What is an `auth provider` in the context of `kfutil`? It's a way to source credentials needed to connect to a Keyfactor
4+
Command API from a secure location rather than a file on disk or environment variables.
45

56
* [Available Auth Providers](#available-auth-providers)
67
* [Azure Key Vault](#azure-key-vault)
@@ -28,8 +29,8 @@ file and will be used by `kfutil` to source credentials for the Keyfactor produc
2829
"type": "azid",
2930
"profile": "default",
3031
"parameters": {
31-
"secret_name": "command-config-1021",
32-
"vault_name": "kfutil"
32+
"secret_name": "kfutil-credentials",
33+
"vault_name": "keyfactor-command-secrets"
3334
}
3435
}
3536
}
@@ -40,6 +41,8 @@ file and will be used by `kfutil` to source credentials for the Keyfactor produc
4041
### Azure Key Vault Secret Format
4142
The format of the Azure Key Vault secret should be the same as if you were to run `kfutil login` and go through the
4243
interactive auth flow. Here's an example of what that would look like:
44+
45+
#### Basic Auth Example
4346
```json
4447
{
4548
"servers": {
@@ -53,6 +56,23 @@ interactive auth flow. Here's an example of what that would look like:
5356
}
5457
}
5558
```
59+
60+
#### oAuth Client Credentials Example
61+
62+
```json
63+
{
64+
"servers": {
65+
"default": {
66+
"host": "my.kfcommand.domain",
67+
"client_id": "my_oauth_client_id",
68+
"client_secret": "my_oauth_client_secret",
69+
"token_url": "https://my_oauth_token_url",
70+
"api_path": "Keyfactor/API"
71+
}
72+
}
73+
}
74+
```
75+
5676
#### Usage
5777

5878
##### Default

0 commit comments

Comments
 (0)