Skip to content

Commit c1aabbb

Browse files
committed
chore(docs): Update PAM docs.
1 parent 8773cec commit c1aabbb

File tree

5 files changed

+19
-13
lines changed

5 files changed

+19
-13
lines changed

docs/kfutil_pam.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Keyfactor PAM Provider APIs.
44

55
### Synopsis
66

7-
A collections of APIs for interacting with Keyfactor PAM Providers and creating new PAM Provider types.
7+
Privileged Access Management (PAM) functionality in Keyfactor Web APIs allows for configuration of third
8+
party PAM providers to secure certificate stores. The PAM component of the Keyfactor API includes methods necessary to
9+
programmatically create, delete, edit, and list PAM Providers.
810

911
### Options
1012

@@ -33,9 +35,9 @@ A collections of APIs for interacting with Keyfactor PAM Providers and creating
3335
* [kfutil pam create](kfutil_pam_create.md) - Create a new PAM Provider, currently only supported from file.
3436
* [kfutil pam delete](kfutil_pam_delete.md) - Delete a defined PAM Provider by ID.
3537
* [kfutil pam get](kfutil_pam_get.md) - Get a specific defined PAM Provider by ID.
36-
* [kfutil pam list](kfutil_pam_list.md) - List defined PAM Providers.
37-
* [kfutil pam types-create](kfutil_pam_types-create.md) - Create a new PAM Provider type, currently only supported from file.
38-
* [kfutil pam types-list](kfutil_pam_types-list.md) - List defined PAM Provider types.
39-
* [kfutil pam update](kfutil_pam_update.md) - Update an existing PAM Provider, currently only supported from file.
38+
* [kfutil pam list](kfutil_pam_list.md) - Returns a list of all the configured PAM providers.
39+
* [kfutil pam types-create](kfutil_pam_types-create.md) - Creates a new PAM provider type.
40+
* [kfutil pam types-list](kfutil_pam_types-list.md) - Returns a list of all available PAM provider types.
41+
* [kfutil pam update](kfutil_pam_update.md) - Updates an existing PAM Provider, currently only supported from file.
4042

4143
###### Auto generated by spf13/cobra on 26-Jul-2023

docs/kfutil_pam_list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## kfutil pam list
22

3-
List defined PAM Providers.
3+
Returns a list of all the configured PAM providers.
44

55
### Synopsis
66

7-
List defined PAM Providers.
7+
Returns a list of all the configured PAM providers.
88

99
```
1010
kfutil pam list [flags]

docs/kfutil_pam_types-create.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
## kfutil pam types-create
22

3-
Create a new PAM Provider type, currently only supported from file.
3+
Creates a new PAM provider type.
44

55
### Synopsis
66

7-
Create a new PAM Provider type, currently only supported from file.
7+
Creates a new PAM Provider type, currently only supported from JSON file and from GitHub. To install from
8+
Github. To install from GitHub, use the --repo flag to specify the GitHub repository and optionally the branch to use.
9+
NOTE: the file from Github must be named integration-manifest.json and must use the same schema as
10+
https://github.com/Keyfactor/hashicorp-vault-pam/blob/main/integration-manifest.json. To install from a local file, use
11+
--from-file to specify the path to the JSON file.
812

913
```
1014
kfutil pam types-create [flags]

docs/kfutil_pam_types-list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## kfutil pam types-list
22

3-
List defined PAM Provider types.
3+
Returns a list of all available PAM provider types.
44

55
### Synopsis
66

7-
List defined PAM Provider types.
7+
Returns a list of all available PAM provider types.
88

99
```
1010
kfutil pam types-list [flags]

docs/kfutil_pam_update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## kfutil pam update
22

3-
Update an existing PAM Provider, currently only supported from file.
3+
Updates an existing PAM Provider, currently only supported from file.
44

55
### Synopsis
66

7-
Update an existing PAM Provider, currently only supported from file.
7+
Updates an existing PAM Provider, currently only supported from file.
88

99
```
1010
kfutil pam update [flags]

0 commit comments

Comments
 (0)