You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docsource/configuration.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
## Overview
2
2
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:
4
4
5
5
-**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).
7
7
-**Certificate Enrollment**:
8
8
- Support certificate enrollment (new keys/certificate).
9
9
- 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
14
14
15
15
## Requirements
16
16
17
-
### 🔐 HydrantID API Key Setup Guide
17
+
### 🔐 HID API Key Setup Guide
18
18
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.
20
20
21
21
#### 📍 Where to Find API Key Management
22
22
23
-
1.**Log in** to your HydrantID instance.
23
+
1.**Log in** to your HID instance.
24
24
- Example: https://acm-stage.hydrantid.com
25
25
2. Click your **user profile icon** (top right) and select **"Profile"**.
26
26
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
40
40
41
41
#### 🔐 Using the API ID and Key with HAWK
42
42
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.
44
44
45
45
##### Required Fields in Authorization Header:
46
46
```text
@@ -56,13 +56,13 @@ Each HTTP request dynamically constructs a HAWK header using:
56
56
57
57
### Root CA Configuration
58
58
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.
60
60
61
61
---
62
62
63
63
## Gateway Registration
64
64
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.
66
66
The certificate selected here should match the issuing CA identified in the [Root CA Configuration](#root-ca-configuration) step.
67
67
68
68
---
@@ -75,7 +75,7 @@ Naming Recommendations:
75
75
- Each Certificate Profile should be named after its Product ID.
76
76
77
77
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.
79
79
80
80
Example:
81
81
| HID Template | Product ID |
@@ -94,7 +94,7 @@ Selecting "Default" bypasses specifying a template.
94
94
All certificate enrollment operations are submitted as "new" requests. However, the plugin supports intelligent handling:
95
95
96
96
-**New Enrollment**:
97
-
- Submits a new CSR against the selected HydrantId Policy.
97
+
- Submits a new CSR against the selected HID Policy.
98
98
-**Renewal vs Reissue**:
99
99
- Uses the prior certificate's serial number (`PriorCertSN`) to retrieve the existing certificate.
100
100
- Compares the expiration date against the current time.
@@ -121,15 +121,15 @@ The plugin uses the `/api/v2/certificates` endpoint to perform full synchronizat
121
121
-**Certificate Parsing**:
122
122
- PEM chains are split into individual certificates.
123
123
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.
125
125
126
126
## Certificate Revocation
127
127
128
128
Revocation requests are sent via a PATCH to the `/api/v2/certificates/{id}` endpoint.
129
129
130
130
**Mapped Revocation Reasons**:
131
131
132
-
| Keyfactor Reason (RFC 5280) |HydrantID Reason |
132
+
| Keyfactor Reason (RFC 5280) |HID Reason |
133
133
|:---|:---|
134
134
| 0 (Unspecified) | Unspecified |
135
135
| 1 (KeyCompromise) | KeyCompromise |
@@ -144,7 +144,7 @@ Revocation requests are sent via a PATCH to the `/api/v2/certificates/{id}` endp
144
144
145
145
## Connection Information Validation
146
146
147
-
The following fields are required when connecting the Gateway to HydrantId:
147
+
The following fields are required when connecting the Gateway to HID:
148
148
149
149
-`HydrantIdBaseUrl`
150
150
-`HydrantIdAuthId`
@@ -156,11 +156,11 @@ Missing or empty fields will cause the plugin initialization to fail.
156
156
157
157
# Additional Notes
158
158
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.
160
160
- If the certificate is still unavailable, the enrollment will be marked **Pending** in Command and should be retried.
161
161
- The plugin uses the Keyfactor standard logging infrastructure (`Keyfactor.Logging`).
0 commit comments