-
Notifications
You must be signed in to change notification settings - Fork 61
W-23349163 akamai scanner ga jh #498
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
JennyHajee
merged 37 commits into
W-23612601-EME-MS2026-08-R1-gr
from
w-23349163-akamai-scanner-GA
Aug 5, 2026
Merged
Changes from all commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
173355c
added new scanner prerequisites topic
JennyHajee 68dc21e
added akamai integration topic and updated existing topics
JennyHajee cf55b6a
added scanner details page
JennyHajee 5fd56fa
edits
JennyHajee c72a751
changed the nav order for scanners
JennyHajee f350621
merged doc drift pr
JennyHajee 7c4bbce
edits
JennyHajee 04627af
added more info about the scanner details page and added Services and…
JennyHajee 4914fde
edits
JennyHajee c5d1fba
added how to remediate the akamai scanner findings in the Conformance…
JennyHajee 94f35d9
edit
JennyHajee 8c194d1
W-23480092 docs: document Akamai security integration in exp-governan…
luanamulesoft 9711f52
Update exp-governance-manage-strategies.adoc
luanamulesoft 6e3af1f
Update exp-governance-work-with-strategies.adoc
luanamulesoft c1acd44
edits for Managing scanners > Available Scanner actions
JennyHajee a921f92
edits to scanner reference table
JennyHajee 35a642c
nav update and fixed indentation
JennyHajee 723dde4
removed exp-scanners-add-from-providers.adoc duplicate from ROOT
JennyHajee 3b9c37c
edits
JennyHajee 973e0c3
added Akamai tenant setup and updated cross reference prerequisites
JennyHajee a79abca
added Akamai tenant setup
JennyHajee 4911546
Merge branch 'W-23612601-EME-MS2026-08-R1-gr' into w-23349163-akamai-…
glenn-rodgers-sf a908f6e
edits
JennyHajee 6099ba4
edit
JennyHajee bea191c
edit
JennyHajee de82693
Merge branch 'W-23612601-EME-MS2026-08-R1-gr' into w-23349163-akamai-…
JennyHajee 7525b75
edits
JennyHajee d33e7ac
reports manual refresh
luanamulesoft a211548
updpated per akamai partner review
JennyHajee e6e8078
edits
JennyHajee c5c0ccf
added activity log info in Viewing scanner details > Overview Tab
JennyHajee 39814d3
edits
JennyHajee cd1e35d
Delete akamai-scanner-docs-review.md
JennyHajee fd8b7f5
Merge branch 'w-23349163-akamai-scanner-GA' of github.com:mulesoft/do…
JennyHajee fdcfebc
copy edits
JennyHajee 4c5e87c
Delete modules/ROOT/nav.adoc
JennyHajee b8582cc
Restore nav.adoc and resolve stash conflict
JennyHajee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| = Using Akamai for Risk Correlation | ||
| :keywords: akamai api security scanner, akamai integration, security risk, vulnerability findings, incident correlation, portfolio catalogs | ||
|
|
||
| Use Akamai for risk correlation to map external security findings to the right services in *Portfolio*. Teams get one view to triage risk, track incidents, and remediate faster. To enable this correlation, configure an Akamai API Security scanner that connects your Akamai account, runs scheduled scans, and surfaces mapped findings on related services in *Portfolio*. The scanner doesn't import or register third-party services. It correlates risk scores, findings, and incidents for APIs and MCP services in one governance workflow. | ||
|
|
||
| The integration relies on a bidirectional sync between your MuleSoft and Akamai API Security tenants. You connect the two tenants with credentials in each direction: Akamai reads your API assets and instances from MuleSoft so it can match its security observations to the correct APIs, and the scanner pulls the resulting findings and incidents back into *Portfolio*. | ||
|
|
||
| == How the Akamai Scanner Differs from Import Scanners | ||
|
|
||
| Most provider scanners discover metadata in external platforms and import services into *Portfolio* catalogs. The Akamai API Security scanner works differently: instead of creating new services, it enriches existing ones with Akamai security data. | ||
|
|
||
| == Before You Begin | ||
|
|
||
| Before setting up the Akamai scanner, make sure you have: | ||
|
|
||
| * Exchange Administrator permission in the target business group. | ||
| * Akamai Security base URL, client ID, and client secret. | ||
| * Access to apply Akamai correlation policy in the environments you want to scan. | ||
| * Existing APIs and MCP services in *Portfolio* catalogs for correlation targets. | ||
|
|
||
| For credential and role details, see xref:exp-scanners-prerequisites-reference.adoc[]. | ||
|
|
||
| == Set Up Tenant Connectivity | ||
|
|
||
| The integration uses a bidirectional sync between your MuleSoft tenant and your Akamai API Security tenant. You provision and configure both tenants. Each MuleSoft customer tenant (root organization) connects to one Akamai API Security tenant (for example, `<tenant>.nonamesec.com`). | ||
|
|
||
| Setup involves credentials in both directions: | ||
|
|
||
| * A *service account* in Akamai, which you configure on the MuleSoft side so the scanner can read findings and incidents from Akamai. | ||
| * A *connected app* in MuleSoft, which you configure on the Akamai side so Akamai can pull API asset and instance information from MuleSoft. | ||
|
|
||
| Complete these steps as an organization administrator: | ||
|
|
||
| . *Create a service account in Akamai API Security.* In your Akamai API Security tenant, create a service account and note its client ID and client secret. | ||
| . *Configure the scanner in MuleSoft.* Add an Akamai scanner and enter the Akamai service account credentials (client ID and client secret) and the Akamai base URL, along with a scan frequency. See <<Set Up the Akamai Scanner>>. | ||
| . *Create a connected app in MuleSoft.* In Anypoint Platform, go to *Access Management* > *Connected Apps* and create an app that acts on its own behalf (client credentials). Add the *Exchange Viewer* or *Asset Viewer* scope so Akamai can read API instance and asset information, then save. Copy the client ID and client secret. | ||
| . *Configure the Akamai-side sync.* In your Akamai API Security tenant, enter the MuleSoft connected app client ID and client secret so Akamai can pull API asset and instance information from MuleSoft. | ||
|
|
||
| == Set Up the Akamai Scanner | ||
|
|
||
| Before you set up the scanner, review the prerequisites for Akamai scanners in xref:exp-scanners-prerequisites-reference.adoc[]. | ||
|
|
||
| . From *Platform* > *Providers*, select *Akamai*. | ||
| . Click *Add Scanner* and enter the connection values. | ||
| . Test the connection. | ||
| . Enter scanner metadata, such as scanner name, description, frequency, and time. | ||
| . Apply the Akamai correlation policy to selected environments. | ||
| . Save the scanner and run a discovery scan. | ||
|
|
||
| == How the Sync Works | ||
|
|
||
| After both tenants are connected, data flows in two directions: | ||
|
|
||
| MuleSoft to Akamai:: | ||
| Akamai periodically pulls API instance and asset information from MuleSoft (typically every few hours) and adds it to its API security inventory. Akamai correlates these API instances with the north-south traffic it observes, so it can attach MuleSoft context — such as organization ID, environment ID, and API instance ID — to the endpoints it monitors. The pull runs at the root organization level. | ||
|
|
||
| Akamai to MuleSoft:: | ||
| The scanner pulls security findings and incidents from Akamai on the schedule you set, then correlates and stores them so they appear on the related services in *Portfolio*. | ||
|
|
||
| For Akamai to observe and correlate traffic, the Akamai correlation policy must be applied to your API instances. This out-of-the-box policy (for Flex Gateway and Mule gateways) stamps correlation headers on API responses so Akamai can match observed traffic to the correct MuleSoft API. Akamai observes north-south traffic only for domains you own and control. | ||
|
|
||
| == Review Scanner Detail Tabs | ||
|
|
||
| After you select a configured Akamai scanner from the provider list, use scanner detail tabs to monitor scanner status, related services, and configuration values. | ||
|
|
||
| For common tab behavior across scanners, see xref:exp-scanners-view-details.adoc[]. | ||
| For Akamai scanners, the *Overview* tab highlights correlation policy status and shows whether existing services are being updated with Akamai risk, findings, and incident data. | ||
| The *Services* tab lists services associated with the scanner and shows which existing services are receiving correlated Akamai security data. | ||
| The *Settings* tab shows scanner configuration values, including schedule and provider connection values, and provides options to edit or delete the scanner. | ||
|
|
||
| == Apply Missing Correlation Policies | ||
|
|
||
| If some environments show that correlation policy isn't applied, you can apply missing policies from the scanner detail page: | ||
|
|
||
| . Open *Platform* > *Providers* and select the configured Akamai scanner. | ||
| . In *Overview*, check the *Akamai Correlation Policy* status. | ||
| . If the status shows missing environments, click *Check again* to apply policy only to those environments. | ||
| . Wait for the status to change to *Applied* and confirm all target environments are covered. | ||
|
|
||
| If policy application fails, verify your Admin API write permissions and environment access, then retry. | ||
|
|
||
| == Where Security Results Appear | ||
|
|
||
| After a successful run, Akamai results appear on existing services: | ||
|
|
||
| * API list views show values in the *Security Risk* column. | ||
| * API detail pages show Akamai security data in *Conformance*. | ||
| * Security sections display violation totals, findings, incidents, and endpoint context. | ||
| * Finding detail views show fields such as status, type, endpoint path, and mapped frameworks. | ||
|
|
||
| == Interpret Risk Status Levels | ||
|
|
||
| The *Security Risk* column shows the risk level assigned to correlated Akamai findings: | ||
|
|
||
| Low:: | ||
| Lower urgency risk. Review and remediate in your normal security lifecycle. | ||
|
|
||
| Medium:: | ||
| Moderate risk. Prioritize remediation after high-risk issues. | ||
|
|
||
| High:: | ||
| Elevated risk. Investigate and remediate first. | ||
|
|
||
| Critical:: | ||
| Highest urgency risk. Remediate immediately. | ||
|
|
||
| == Remediate Risks from the API Conformance Tab | ||
|
|
||
| Use the API *Conformance* tab in *Portfolio* to triage and remediate Akamai findings: | ||
|
|
||
| . Open the API from the *APIs* catalog in *Portfolio*. | ||
| . Select *Conformance* and review the *Akamai* section, including findings and incidents. | ||
| . Select a finding to open details, such as endpoint, severity, and mapped standards. | ||
| . Apply recommended remediation policies directly from the finding detail view when available. | ||
| . Re-run the scanner after remediation to confirm updated findings and risk levels. | ||
|
|
||
| If no direct remediation policy is available for a finding, use the finding details to update the API configuration in your gateway or upstream system, then scan again to verify the result. | ||
|
|
||
| == Troubleshoot Missing Akamai Findings | ||
|
|
||
| If a scan completes but results don't appear: | ||
|
|
||
| * Verify the correlation policy is applied in the same environment as the service instance. | ||
| * Confirm the target service already exists in *Portfolio* catalogs. | ||
| * Confirm scanner scope and business group match the service location. | ||
| * Re-run the scanner after connection or policy changes. | ||
|
|
||
| == See Also | ||
|
|
||
| * xref:exp-scanners-add-from-providers.adoc[] | ||
| * xref:exp-providers-manage.adoc[] | ||
| * xref:exp-scanners-view-details.adoc[] | ||
| * xref:exp-scanners-manage.adoc[] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have this feature? i dont think we have correlation policies
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hi @sparshagarwal-nonemu, yes. In this integration, we use correlation policies to make sure the security findings we see in Akamai are attributed to the exact API instance in MuleSoft.