Skip to content

Commit b45c404

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 983228c commit b45c404

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ To use the Azure Key Vault Universal Orchestrator extension, you **must** create
554554

555555

556556

557-
### AKV
557+
<details><summary>Click to expand details</summary>
558558

559559
The Azure Keyvault Certificate Store Type is designed to integrate with Microsoft Azure Key Vault, enabling users to
560560
manage and automate the lifecycle of cryptographic certificates stored in Azure Key Vault through Keyfactor Command.
@@ -567,8 +567,7 @@ including Service Principals, User Assigned Managed Identities, and System Assig
567567
that only authorized entities can manage the certificates stored within the Key Vault.
568568

569569
While this Certificate Store Type provides a powerful means of managing certificates, there are some important caveats
570-
to consider. For example, if your instance of Azure Key Vault utilizes private or custom endpoints, or is hosted outside
571-
of the Azure Public cloud (e.g., Government, China, Germany instances), certain functions like discovery job
570+
to consider. For example, if your instance of Azure Key Vault utilizes private or custom endpoints, or is hosted outside the Azure Public cloud (e.g., Government, China, Germany instances), certain functions like discovery job
572571
functionality may not be supported. Additionally, the configuration of access control through Azure's Role Based Access
573572
Control (RBAC) or classic Access Policies must be meticulously managed to ensure sufficient permissions for the
574573
orchestrator to perform its tasks.
@@ -589,7 +588,9 @@ Certificate Store Type within your organization’s security framework.
589588
| Reenrollment | 🔲 Unchecked |
590589
| Create | ✅ Checked |
591590

592-
#### Creation Using kfutil:
591+
#### Store Type Creation
592+
593+
##### Using kfutil:
593594
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
594595
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
595596
<details><summary>Click to expand AKV kfutil details</summary>
@@ -612,9 +613,8 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out
612613

613614

614615
#### Manual Creation
615-
If you do not wish to use the `kfutil` CLI then certificate store types can be creating in the web UI as described below.
616-
617-
616+
Below are instructions on how to create the AKV store type manually in
617+
the Keyfactor Command Portal
618618
<details><summary>Click to expand manual AKV details</summary>
619619

620620
Create a store type called `AKV` with the attributes in the tables below:
@@ -822,7 +822,7 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
822822

823823
### Azure Keyvault Discovery Job
824824

825-
1) Navigate to Orchestrators > Management in the platform.
825+
1) Navigate to `Orchestrators > Management` in the platform.
826826

827827
![Manage Orchestrators](/Images/orch-manage.png)
828828

@@ -837,11 +837,11 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
837837

838838
### Create the discovery job
839839

840-
1) Navigate to "Locations > Certificate Stores"
840+
1) Navigate to `Locations > Certificate Stores`
841841

842842
![Locations Cert Stores](/Images/locations-certstores.png)
843843

844-
2) Click the "Discover" tab, and then the "Schedule" button.
844+
2) Click the `Discover` tab, and then the `Schedule` button.
845845

846846
![Discovery Schedule](/Images/discover-schedule.png)
847847

@@ -888,7 +888,7 @@ server credentials in the following way:
888888
889889
Follow these steps to store the values:
890890
891-
1) Enter the _Tenant Id_ in the **Client Machine** field.
891+
1) Enter the _Tenant ID_ in the **Client Machine** field.
892892
893893
![Discovery Form](/Images/discovery-form-client-machine.png)
894894
@@ -902,12 +902,12 @@ Follow these steps to store the values:
902902
903903
4) Enter again to confirm, and click save.
904904
905-
5) Click "UPDATE SERVER PASSWORD" and update with the appropriate value (`<client secret>` or `managed`) following the
905+
5) Click `UPDATE SERVER PASSWORD` and update with the appropriate value (`<client secret>` or `managed`) following the
906906
same steps as above.
907907
908908
6) Select a time to run the discovery job.
909909
910-
7) Enter commma seperated list of tenant ID's in the "Directories to search" field.'
910+
7) Enter comma seperated list of tenant ID's in the `Directories to search` field.
911911

912912
> :warning:
913913
> If nothing is entered here, the default Tenant ID included with the credentials will be used. For system managed
@@ -917,7 +917,7 @@ Follow these steps to store the values:
917917

918918
### Approve the Certificate Store
919919

920-
When the Discovery job runs successfully, it will list the existing Azure Keyvaults that are acessible by our service
920+
When the Discovery job runs successfully, it will list the existing Azure Keyvaults that are accessible by our service
921921
principal.
922922

923923
In this example, our job returned these Azure Keyvaults.
@@ -957,7 +957,7 @@ The steps to take this are:
957957

958958
- **Category**: Azure Keyvault
959959
- **Container**: _optional_
960-
- **Client Machine**: If applicable; Tenant Id.
960+
- **Client Machine**: If applicable; Tenant ID.
961961

962962
- Note: These will only have to be entered once, even if adding multiple certificate stores.
963963
- Follow the steps [here](#store-the-server-credentials-in-keyfactor) to enter them.

0 commit comments

Comments
 (0)