Skip to content

Commit a451462

Browse files
Update configuration.md
1 parent ef663ca commit a451462

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

docsource/configuration.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## Overview
22

3-
HydrantId operates a PKI-as-a-service platform for customers around the globe. The AnyGateway solution for HydrantId allows Keyfactor Command to perform:
3+
HID operates a PKI-as-a-service platform for customers around the globe. The AnyGateway solution for HID allows Keyfactor Command to perform:
44

55
- **CA Sync**:
6-
- Download all certificates issued by connected Enterprise-tier CAs in HydrantId (full sync).
6+
- Download all certificates issued by connected Enterprise-tier CAs in HID (full sync).
77
- **Certificate Enrollment**:
88
- Support certificate enrollment (new keys/certificate).
99
- Intelligent handling of Renewal vs Reissue based on certificate expiration.
@@ -14,13 +14,13 @@ HydrantId operates a PKI-as-a-service platform for customers around the globe. T
1414

1515
## Requirements
1616

17-
### 🔐 HydrantID API Key Setup Guide
17+
### 🔐 HID API Key Setup Guide
1818

19-
This guide explains how to generate and use an API Key ID and Secret in HydrantID for authenticated API access.
19+
This guide explains how to generate and use an API Key ID and Secret in HID for authenticated API access.
2020

2121
#### 📍 Where to Find API Key Management
2222

23-
1. **Log in** to your HydrantID instance.
23+
1. **Log in** to your HID instance.
2424
- Example: https://acm-stage.hydrantid.com
2525
2. Click your **user profile icon** (top right) and select **"Profile"**.
2626
3. In the **Profile** page, scroll to the section labeled `API Keys`.
@@ -40,7 +40,7 @@ This guide explains how to generate and use an API Key ID and Secret in HydrantI
4040

4141
#### 🔐 Using the API ID and Key with HAWK
4242

43-
HydrantID uses [HAWK Authentication](https://github.com/hueniverse/hawk) to secure its API.
43+
HID uses [HAWK Authentication](https://github.com/hueniverse/hawk) to secure its API.
4444

4545
##### Required Fields in Authorization Header:
4646
```text
@@ -56,13 +56,13 @@ Each HTTP request dynamically constructs a HAWK header using:
5656

5757
### Root CA Configuration
5858

59-
Both the Keyfactor Command and AnyCA Gateway REST servers must trust the root CA, and any applicable intermediate CAs for HydrantID.
59+
Both the Keyfactor Command and AnyCA Gateway REST servers must trust the root CA, and any applicable intermediate CAs for HID.
6060

6161
---
6262

6363
## Gateway Registration
6464

65-
The Gateway Registration tab configures the root or issuing CA certificate for the respective CA in HydrantId.
65+
The Gateway Registration tab configures the root or issuing CA certificate for the respective CA in HID.
6666
The certificate selected here should match the issuing CA identified in the [Root CA Configuration](#root-ca-configuration) step.
6767

6868
---
@@ -75,7 +75,7 @@ Naming Recommendations:
7575
- Each Certificate Profile should be named after its Product ID.
7676

7777
Behavior:
78-
- The plugin maps HydrantID Policy Names directly to Product IDs in the Gateway Portal.
78+
- The plugin maps HID Policy Names directly to Product IDs in the Gateway Portal.
7979

8080
Example:
8181
| HID Template | Product ID |
@@ -94,7 +94,7 @@ Selecting "Default" bypasses specifying a template.
9494
All certificate enrollment operations are submitted as "new" requests. However, the plugin supports intelligent handling:
9595

9696
- **New Enrollment**:
97-
- Submits a new CSR against the selected HydrantId Policy.
97+
- Submits a new CSR against the selected HID Policy.
9898
- **Renewal vs Reissue**:
9999
- Uses the prior certificate's serial number (`PriorCertSN`) to retrieve the existing certificate.
100100
- Compares the expiration date against the current time.
@@ -121,15 +121,15 @@ The plugin uses the `/api/v2/certificates` endpoint to perform full synchronizat
121121
- **Certificate Parsing**:
122122
- PEM chains are split into individual certificates.
123123

124-
> Note: HydrantId's API does not allow filtering certificates by CA, so all certificates from the tenant are synced.
124+
> Note: HID's API does not allow filtering certificates by CA, so all certificates from the tenant are synced.
125125
126126
## Certificate Revocation
127127

128128
Revocation requests are sent via a PATCH to the `/api/v2/certificates/{id}` endpoint.
129129

130130
**Mapped Revocation Reasons**:
131131

132-
| Keyfactor Reason (RFC 5280) | HydrantID Reason |
132+
| Keyfactor Reason (RFC 5280) | HID Reason |
133133
|:---|:---|
134134
| 0 (Unspecified) | Unspecified |
135135
| 1 (KeyCompromise) | KeyCompromise |
@@ -144,7 +144,7 @@ Revocation requests are sent via a PATCH to the `/api/v2/certificates/{id}` endp
144144

145145
## Connection Information Validation
146146

147-
The following fields are required when connecting the Gateway to HydrantId:
147+
The following fields are required when connecting the Gateway to HID:
148148

149149
- `HydrantIdBaseUrl`
150150
- `HydrantIdAuthId`
@@ -156,11 +156,11 @@ Missing or empty fields will cause the plugin initialization to fail.
156156

157157
# Additional Notes
158158

159-
- After enrollment, the plugin polls HydrantId's `/csr/{id}/certificate` endpoint for up to **30 seconds** to retrieve the newly issued certificate.
159+
- After enrollment, the plugin polls HID's `/csr/{id}/certificate` endpoint for up to **30 seconds** to retrieve the newly issued certificate.
160160
- If the certificate is still unavailable, the enrollment will be marked **Pending** in Command and should be retried.
161161
- The plugin uses the Keyfactor standard logging infrastructure (`Keyfactor.Logging`).
162162

163163
# 📌 Related Documentation
164164

165165
- [HAWK Authentication Specification](https://github.com/hueniverse/hawk)
166-
- [HydrantID API Documentation](https://support.hydrantid.com/hc/en-us)
166+
- [HID API Documentation](https://support.hydrantid.com/hc/en-us)

0 commit comments

Comments
 (0)