readme updates

Author: bhillkeyfactor

docsource/configuration.md

@@ -1,11 +1,65 @@
 ## Overview
 
-The Clearpass AnyCA Gateway REST plugin extends the capabilities of Aruba Clearpass Onboard to Keyfactor Command via the Keyfactor AnyCA Gateway REST. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies:
+The Clearpass AnyCA Gateway REST plugin extends the capabilities of Aruba Clearpass Onboard to Keyfactor Command via the Keyfactor AnyCA Gateway REST. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies :
 * CA Sync:
     * Download all certificates issued to the customer by the Clearpass CA.
 * Certificate enrollment for the Clearpass products listed in the manifest file:
-    * Support certificate enrollment (new keys/certificate). [see disclaimer]
+    * Support certificate enrollment (new keys/certificate)
         * Support certificate re-issuance/renewal (new public/private keys with the same or different domain names).
 * Certificate revocation:
     * Request revocation of a previously issued certificate.
 
+## Requirements
+
+# ClearPass Onboard: Setting Up an API Client
+
+## Step 1: Access ClearPass Admin Console
+1. **Login** to the ClearPass Admin console using your administrator credentials.
+2. Navigate to **Administration** > **API Services** > **API Clients**.
+
+## Step 2: Create a New API Client
+1. Click on the **Add API Client** button to create a new API client.
+
+## Step 3: Configure the API Client
+
+- **Client ID**:
+  - Enter some value such as `Client1` in the **Client ID** field.
+  - This is the value you will use in the OAuth2 `client_id` parameter.
+
+- **Description**:
+  - You can provide a description for this API client, such as "Sample API client for testing purposes," in the **Description** field.
+
+- **Enabled**:
+  - Ensure the **Enabled** checkbox is selected. This means the API client will be active and able to make API calls.
+
+- **Operating Mode**:
+  - Select **ClearPass REST API - Client will be used for API calls to ClearPass** from the **Operating Mode** dropdown.
+
+- **Operator Profile**:
+  - Select **Network Administrator** from the **Operator Profile** dropdown.
+  - This profile will provide the API client with the necessary permissions to interact with ClearPass.
+
+- **Grant Type**:
+  - Select **Client credentials (`grant_type=client_credentials`)** from the **Grant Type** dropdown.
+  - This means the API client will authenticate using its client credentials.
+
+- **Client Secret**:
+  - Since this is a non-public client, ensure the **Generate a new client secret** checkbox is selected.
+  - The system will generate a new client secret. For example, `FFFDDDCCCRRR4444DDDDDDDDDDD`.
+  - **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.
+
+## Step 4: Set Token Lifetimes
+
+- **Access Token Lifetime**:
+  - Enter `8` in the **Access Token Lifetime** field.
+  - Select **hours** from the dropdown. This means the access token will be valid for 8 hours.
+
+
+## Step 5: Save the API Client
+1. Once all fields are configured, click the **Create API Client** button to save the new API client.
+2. If you need to cancel, click the **Cancel** button.
+
+## Step 6: Use the API Client
+- Use the **Client ID** (`Client1`) and **Client Secret** (`FFFDDDCCCRRR4444DDDDDDDDDDD`) in your Gateway Configuration Settings.
+
+