# Akamai Identity Cloud

This article outlines the integration with Akamai Identity Cloud, enabling streamlined metadata management through features such as crawling, data preview, and manual lineage building. It also ensures secure authentication via Credential Manager.

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FdZW4lFt9xyqhIZt8XgSk%2Funknown.png?alt=media&#x26;token=f7919c1a-3865-447d-93d8-2e3c74991ebb" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="464.8333740234375"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Identity/Access Management</td></tr><tr><td>Connector Version</td><td>Release6.3.4.x</td></tr><tr><td>Releases Supported (Available from)</td><td>Release6.3.x</td></tr><tr><td>Connectivity<br> [How the connection is established with Akamai Identity Cloud]</td><td>REST APIs</td></tr></tbody></table>

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ❌      |

### Metadata Mapping

The following objects are crawled from the Akamai Identity Cloud and mapped to the corresponding UI assets.

<table><thead><tr><th width="274.83331298828125">Akamai Identity Cloud Object</th><th width="265">Akamai Identity Cloud Attribute</th><th width="199.6666259765625">OvalEdge Attribute</th><th width="185.5001220703125">OvalEdge Category</th><th width="176.3333740234375">OvalEdge Type</th></tr></thead><tbody><tr><td>System Objects</td><td>Results</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Object Fields</td><td>Name</td><td>Column Name</td><td>Columns</td><td>Object Field</td></tr><tr><td>Type</td><td>Column Type</td><td>            -</td><td>            -</td><td>Type</td></tr><tr><td>description</td><td>Source Description</td><td>            -</td><td>            -</td><td> Description</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

### Service Account User Permissions

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻 Who can provide these permissions?** The Akamai Identity Cloud administrator grants these permissions, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th>Operation</th><th width="314">Endpoint</th><th>Access Permission</th></tr></thead><tbody><tr><td>Get List System Objects</td><td>/entityType.list</td><td>direct_read_access</td></tr><tr><td>Get List Fields for Object</td><td>/entityType.getAccessSchema/{type_name}&#x26;{access_type}&#x26;{for_client_id}</td><td>direct_read_access &#x26; for_clinet_id</td></tr><tr><td>Get field metadata</td><td>/entity.find/{type_name}</td><td>direct_read_access</td></tr><tr><td>Get the count of metadata</td><td>/entity.count</td><td>direct_read_access</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log in to **OvalEdge**, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Akamai Identity Cloud,** and complete the required parameters.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Fields marked with an asterisk (*) are mandatory for establishing a connection.</p></div>

<table><thead><tr><th width="219.8333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Akamai Identity Cloud" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>HashiCorp</li><li>AWS Secrets Manager</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Akamai Identity Cloud connection              </p><p>(Example: "Akamai Identity Cloud_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter the description related to the connector.</td></tr><tr><td>Server*</td><td>The "Host URL" specifies the base endpoint of the Akamai Identity Cloud instance. It serves as the primary address where the API requests are directed. This URL is essential for establishing a connection to the correct environment (e.g., development, staging, production) within Akamai Identity Cloud.</td></tr><tr><td>Client Id*</td><td>Enter the Akamai Identity Cloud database Client Id.</td></tr><tr><td>Client Secret*</td><td>The Client Secret field is a confidential key paired with the Client ID. It authenticates OvalEdge with Akamai Identity Cloud to securely authorize API requests.</td></tr><tr><td>For Client Id*</td><td>The "For Client Id" field in the Akamai Identity Cloud connector specifies the application’s unique client identifier used to authenticate and authorize requests.</td></tr><tr><td>Schema Name*</td><td>The Schema Name field in the Akamai Identity Cloud Connector specifies the user data schema (profile definition) that the connector should use to map and synchronize identity attributes.</td></tr><tr><td>Proxy Enabled*</td><td>Select either "Yes" or "No" from the "Proxy Enabled" dropdown list according to the proxy settings.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219.00006103515625"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220.666748046875"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr></tbody></table>

\
**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="220.6666259765625"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.66668701171875"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling and profiling.

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The Crawl option is selected by default. Click the **Crawl & Profile** radio button to enable both operations.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Databases** tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

### Other Operations

The **Connectors** page in OvalEdge provides a centralized view of all configured connectors, including the health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a **green** icon for active connections and a **red** icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the **Eye** icon next to the connector name to view connector details, including Schemas, Tables, and Columns.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Profiler:** Customize data profiling rules and methods.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
  * **Others:** Configure notification recipients for metadata changes.
* **Delete Connector:** Remove a connector with confirmation.

## Limitations

<table><thead><tr><th width="220.666748046875">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Sample Profiling</td><td>The Akamai Identity Cloud connector performs sample profiling with a maximum limit of 5,000 rows.</td></tr></tbody></table>

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="83.44451904296875">S.No.</th><th width="296.888916015625">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating AKAMAIIDENTITYCLOUD connection client_secret was not valid for the following reason: client_secret is not a valid id</td><td><p>Description: The connection attempt to Akamai Identity Cloud failed because the provided client_secret was invalid.</p><p>Resolution: Verify that the correct client_secret value from the Akamai Identity Cloud application is being used.</p></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA.