Skip to content

Commit eaec926

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 3a9d324 commit eaec926

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
5454
5555
## Requirements
5656

57-
---
58-
5957
### ClearPass Onboard: Setting Up an API Client
6058

6159
#### Step 1: Access ClearPass Admin Console
@@ -81,7 +79,9 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
8179
- Select **ClearPass REST API - Client will be used for API calls to ClearPass** from the **Operating Mode** dropdown.
8280

8381
- **Operator Profile**:
82+
8483
- Select **Super Administrator** from the **Operator Profile** dropdown.
84+
8585
- This profile will provide the API client with the necessary permissions to interact with ClearPass.
8686

8787
- **Grant Type**:
@@ -94,7 +94,6 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
9494
- **Note:** The client secret is used in the OAuth2 `client_secret` parameter and will be encrypted once stored, so be sure to copy it securely.
9595

9696
#### Step 4: Set Token Lifetimes
97-
9897
- **Access Token Lifetime**:
9998
- Enter `8` in the **Access Token Lifetime** field.
10099
- Select **hours** from the dropdown. This means the access token will be valid for 8 hours.
@@ -166,13 +165,16 @@ At the time of writing, there was no API call available to get a list of Certifi
166165

167166
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Aruba Clearpass Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/aruba-clearpass-caplugin/releases/latest) from GitHub.
168167

169-
3. Copy the unzipped directory (usually called `net6.0`) to the Extensions directory:
168+
3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory:
169+
170170

171171
```shell
172+
Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations:
172173
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions
174+
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions
173175
```
174176

175-
> The directory containing the Aruba Clearpass Gateway AnyCA Gateway REST plugin DLLs (`net6.0`) can be named anything, as long as it is unique within the `Extensions` directory.
177+
> The directory containing the Aruba Clearpass Gateway AnyCA Gateway REST plugin DLLs (`net6.0` or `net8.0`) can be named anything, as long as it is unique within the `Extensions` directory.
176178

177179
4. Restart the AnyCA Gateway REST service.
178180

@@ -184,7 +186,7 @@ At the time of writing, there was no API call available to get a list of Certifi
184186

185187
* **Gateway Registration**
186188

187-
TODO Gateway Registration is a required section
189+
Each defined Certificate Authority in the AnyCA Gateway REST can support one issuing certificate authority. Since Aruba ClearPass Onboard has multiple available Certificate Authorities, if you require certificate enrollment from multiple Aruba ClearPass Certificate Authorities, you must define multiple Certificate Authorities in the AnyCA Gateway REST. This will manifest in Command as one Aruba ClearPass CA per defined Certificate Authority.
188190

189191
* **CA Connection**
190192

@@ -194,6 +196,7 @@ At the time of writing, there was no API call available to get a list of Certifi
194196
* **BaseUrl** - Base Url for ClearPass API such as https://url:8443
195197
* **ClearPassApiClient** - ClearPass API Client Name
196198
* **ClearPassCaId** - ClearPass Ca Id. Example would be 2. In ClearPass Onboard UI, click edit on the Ca and look at the id in the Url.
199+
* **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available.
197200

198201
2. Define [Certificate Profiles](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCP-Gateway.htm) and [Certificate Templates](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCA-Gateway.htm) for the Certificate Authority as required. One Certificate Profile must be defined per Certificate Template. It's recommended that each Certificate Profile be named after the Product ID. The Aruba Clearpass Gateway plugin supports the following product IDs:
199202
@@ -205,12 +208,6 @@ At the time of writing, there was no API call available to get a list of Certifi
205208
206209
3. Follow the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCA-Keyfactor.htm) to add each defined Certificate Authority to Keyfactor Command and import the newly defined Certificate Templates.
207210
208-
4. In Keyfactor Command (v12.3+), for each imported Certificate Template, follow the [official documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Configuring%20Template%20Options.htm) to define enrollment fields for each of the following parameters:
209-
210-
* **NumberOfDaysValid** - OPTIONAL: The number of days of validity to use when requesting certs. If not provided, default is 365.
211-
212-
213-
214211
215212
216213
## License

integration-manifest.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@
2727
{
2828
"name": "ClearPassCaId",
2929
"description": "ClearPass Ca Id. Example would be 2. In ClearPass Onboard UI, click edit on the Ca and look at the id in the Url."
30+
},
31+
{
32+
"name": "Enabled",
33+
"description": "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available."
3034
}
3135
],
3236
"enrollment_config": [

0 commit comments

Comments
 (0)