Skip to content

Add doc for agent identity#284

Open
kalaiyarasiganeshalingam wants to merge 2 commits intowso2:mainfrom
kalaiyarasiganeshalingam:main
Open

Add doc for agent identity#284
kalaiyarasiganeshalingam wants to merge 2 commits intowso2:mainfrom
kalaiyarasiganeshalingam:main

Conversation

@kalaiyarasiganeshalingam
Copy link
Copy Markdown

@kalaiyarasiganeshalingam kalaiyarasiganeshalingam commented Mar 27, 2026

Purpose

$Subject

Fix: https://github.com/wso2-enterprise/integration-engineering/issues/734

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for managing AI agent identity and access control: agent registration and credentials, configuring identity providers, defining protected resources and scopes, creating roles and assigning permissions, configuring tool authentication, and steps to deploy integrations and interact with agents.
    • Added a navigation entry linking this guide under AI Agents and Gen AI Integrations → Agents.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

Warning

Rate limit exceeded

@kalaiyarasiganeshalingam has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 39 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 39 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 86df3837-ea8e-4939-8099-e1157de27f58

📥 Commits

Reviewing files that changed from the base of the PR and between 81bf13a and 5b828a1.

📒 Files selected for processing (1)
  • en/docs/integration-guides/ai/agents/managing-agent-identity-and-access-control.md

Walkthrough

Added a new documentation page that provides an end-to-end setup guide for securing AI agent identity, authentication, and authorization (Asgardeo agent registration, protected resources/scopes, client app registration, role/permission assignment, Integrator configuration, and tool auth), and updated MkDocs navigation to include it. (Documentation-only change.)

Changes

Cohort / File(s) Summary
New documentation page
en/docs/integration-guides/ai/agents/managing-agent-identity-and-access-control.md
Added a detailed tutorial covering prerequisites (Agent ID/Secret, OAuth client details), Asgardeo agent registration, defining protected targets (MCP servers / API resources and scopes), registering MCP and non‑MCP client apps (redirect URIs, grant types, PKCE/auth settings, JWT token config), authorizing API scopes, creating roles and assigning resource permissions to the agent, WSO2 Integrator integration steps (MCP vs non‑MCP), adding agent credentials in AI Service advanced config (AgentIdAuthConfig fields), configuring tool authentication and scopes, and running/chatting via the Integrator UI.
Navigation update
en/mkdocs.yml
Added a navigation entry under "AI Agents and Other Gen AI Integrations → Agents" linking to the new documentation page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through pages, pen in paw,
I gathered keys and scoped the law,
I registered agents, tied each part,
So integrations start with heart,
A tiny rabbit's techie awe. 🥕

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is largely incomplete, missing most required template sections including Goals, Approach, User stories, Release notes, Documentation links, Training, Certification, Marketing, Automation tests, Security checks, Samples, Related PRs, Migrations, Test environment, and Learning. Complete the PR description by filling in all required template sections. At minimum, provide Goals, Approach with documentation links, Release notes, and Documentation confirmation for this documentation-only change.
Title check ❓ Inconclusive The title is vague and incomplete. 'Add doc for agent identity' is generic and does not clearly describe the scope or specific content being added. Revise the title to be more specific about the documentation content, such as 'Add documentation for managing agent identity and access control' or 'Add guide for securing AI agent interactions with identity and access control'.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@en/docs/integration-guides/ai/agents/managing-agent-identity-and-access-control.md`:
- Around line 192-193: Replace the decorative arrow characters in the
documentation body by changing the lines that currently use "→" after the
boolean values (`true` and `false`) to plain text phrasing; e.g., update the
entries that reference `true` and `false` (the list items containing `true` and
`false`) so they read like "`true`: Recommended for public clients (more
secure)" and "`false`: Used with client secret (confidential clients)" instead
of using the arrow symbol.
- Around line 2-6: Change the document title and top-level heading from Title
Case to sentence case: update the front-matter "title" value to "Managing agent
identity and access control" and change the H1 line "# Managing Agent Identity
and Access Control" to "# Managing agent identity and access control" so only
the first word and proper nouns are capitalized.
- Line 210: The heading "###  For Non-MCP Tool" has extra spaces after the
marker and is not in sentence case; update the heading to use a single space
after the marker and sentence case (capitalize only the first word and proper
nouns) — e.g., change the "For Non-MCP Tool" heading text to "For non-MCP tool"
and ensure it is written as "### For non-MCP tool" (single space after ###)
wherever that heading appears.
- Around line 48-223: The document uses title case for several headings (e.g.,
"Configure Resources", "Register an Application", "Configure Role", "Add Agent
Credential")—please update all section and subsection headings to sentence case
(capitalize only the first word and proper nouns) throughout this page
(including headings like "Configure MCP Tool", "Configure Non-MCP Tool",
"Authorize APIs", "Step 1: Create the Integration", etc.), ensuring consistency
and that only proper nouns remain capitalized.
- Around line 70-71: Replace the sentence "To allow your agent to execute secure
tool, client needs to be set up in Asgardeo." with a concise, plain-language
version such as: "To let your agent access secure tools, set up a client in
Asgardeo." Use this revised sentence in the document section that references
agent access and Asgardeo configuration to improve grammar and clarity.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 932bdbe8-5a21-4ae8-9018-b9a70f8546a2

📥 Commits

Reviewing files that changed from the base of the PR and between f0b5ede and cc7edf6.

⛔ Files ignored due to path filters (8)
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/add_tool_scope.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/agent_advanced_config.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/agent_creation_form.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/overview-diagram.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/run_integration.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/tool_scope.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/toolkit_auth_config.png is excluded by !**/*.png
  • en/docs/assets/img/integration-guides/ai/agents/managing-agent-identity-and-access-control/toolkit_diagram.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • en/docs/integration-guides/ai/agents/managing-agent-identity-and-access-control.md
  • en/mkdocs.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant