Skip to content

Commit 0bc61c5

Browse files
committed
chore(docs): Update Basic auth verbiage and add audidence to oauth config vars
Signed-off-by: spbsoluble <[email protected]>
1 parent edf6f7d commit 0bc61c5

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Invoke-WebRequest -Uri "https://raw.githubusercontent.com/Keyfactor/kfutil/main/
7272

7373
### Basic Auth
7474

75-
Currently, only Active Directory `Basic` authentication is supported.
75+
Currently `Basic Authentication` via `Active Directory` is the *ONLY* supported method of `Basic Authentication`.
7676

7777
| Name | Description | Default |
7878
|--------------------|---------------------------------------------------------------------------------------------|---------|
@@ -87,8 +87,10 @@ Currently, only Active Directory `Basic` authentication is supported.
8787
| KEYFACTOR_AUTH_CLIENT_ID | Keyfactor Auth Client ID | |
8888
| KEYFACTOR_AUTH_CLIENT_SECRET | Keyfactor Auth Client Secret | |
8989
| KEYFACTOR_AUTH_TOKEN_URL | URL to request an access token from Keyfactor Auth | |
90-
| KEYFACTOR_AUTH_SCOPES | Scopes to request when authenticating to Keyfactor Command API | `openid` |
90+
| KEYFACTOR_AUTH_SCOPES | Scopes to request when authenticating to Keyfactor Command API. Each scope MUST be separated by `,` | `openid` |
91+
| KEYFACTOR_AUTH_AUDIENCE | Audience to request when authenticating to Keyfactor Command API | |
9192
| KEYFACTOR_AUTH_ACCESS_TOKEN | Access token to use to authenticate to Keyfactor Command API. This can be supplied directly or generated via client credentials | |
93+
| KEYFACTOR_AUTH_CA_CERT | Either a file path or PEM encoded string to a CA certificate to use when connecting to Keyfactor Auth | |
9294

9395
### kfutil specific
9496

readme_source.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Invoke-WebRequest -Uri "https://raw.githubusercontent.com/Keyfactor/kfutil/main/
5050

5151
### Basic Auth
5252

53-
Currently, only Active Directory `Basic` authentication is supported.
53+
Currently `Basic Authentication` via `Active Directory` is the *ONLY* supported method of `Basic Authentication`.
5454

5555
| Name | Description | Default |
5656
|--------------------|---------------------------------------------------------------------------------------------|---------|
@@ -65,8 +65,10 @@ Currently, only Active Directory `Basic` authentication is supported.
6565
| KEYFACTOR_AUTH_CLIENT_ID | Keyfactor Auth Client ID | |
6666
| KEYFACTOR_AUTH_CLIENT_SECRET | Keyfactor Auth Client Secret | |
6767
| KEYFACTOR_AUTH_TOKEN_URL | URL to request an access token from Keyfactor Auth | |
68-
| KEYFACTOR_AUTH_SCOPES | Scopes to request when authenticating to Keyfactor Command API | `openid` |
68+
| KEYFACTOR_AUTH_SCOPES | Scopes to request when authenticating to Keyfactor Command API. Each scope MUST be separated by `,` | `openid` |
69+
| KEYFACTOR_AUTH_AUDIENCE | Audience to request when authenticating to Keyfactor Command API | |
6970
| KEYFACTOR_AUTH_ACCESS_TOKEN | Access token to use to authenticate to Keyfactor Command API. This can be supplied directly or generated via client credentials | |
71+
| KEYFACTOR_AUTH_CA_CERT | Either a file path or PEM encoded string to a CA certificate to use when connecting to Keyfactor Auth | |
7072

7173
### kfutil specific
7274

0 commit comments

Comments
 (0)