Add documentation for agents with user login and OAuth configuration#6045
Add documentation for agents with user login and OAuth configuration#6045ranuka-laksika wants to merge 4 commits intowso2:masterfrom
Conversation
|
Warning Rate limit exceeded
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 17 minutes and 24 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated documentation for AI agent registration and management, adding sections that define agent types based on user login requirements, describe OAuth/OIDC application creation for user-login agents, explain agent-type-specific parameters and grant types, detail OAuth application management procedures, and update agent deletion guidance with implications for automatically created OAuth applications. Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
en/includes/guides/agentic-ai/ai-agents/register-and-manage-agents.md (1)
81-83: Document CIBA settings with defaults and allowed values.These configuration bullets explain what the settings do, but they do not state defaults/constraints. Add defaults and valid values to reduce ambiguity at setup time (for example, expiry default and valid notification channels).
As per coding guidelines, “When documenting configuration, describe what the setting controls, state the default value, state constraints (type, valid range, allowed values), provide a minimal example, and explain when the user should change it.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/agentic-ai/ai-agents/register-and-manage-agents.md` around lines 81 - 83, Update the two CIBA configuration bullets for "Authentication Request Expiry Time" and "Notification Channels" to include default values, types/constraints, allowed values and a minimal example: for Authentication Request Expiry Time (mention the default seconds, type integer, allowed range e.g., 60–86400 and when to change it) and for Notification Channels (list allowed values: Email, SMS, Both, default value, type enum/string and an example usage), and ensure the text follows the doc guideline to state what the setting controls, default, constraints, example, and guidance on when to change it.
🤖 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/includes/guides/agentic-ai/ai-agents/register-and-manage-agents.md`:
- Line 24: The Vale spell-check flags the term "Chatbots" in the sentence
"Chatbots that respond to user queries in real-time" (and the same term at line
78); either change the wording to use the accepted phrasing such as "chatbot" or
"chatbot agents" throughout the document (including that exact sentence and the
occurrence at line 78) or add "Chatbots/chatbots" (or your preferred casing) to
the repo vocabulary accept list in
.vale/styles/config/vocabularies/vocab/accept.txt so Vale stops flagging it;
update the two occurrences consistently and re-run Vale to confirm warnings are
resolved.
- Around line 87-90: Add blank lines before and after the grant-type bullet list
to satisfy MD032 and improve readability: insert an empty line above the line
that starts the list ("For agents with user login enabled...") or immediately
after that sentence, and another empty line after the last list item ("...grant
type") so the list is surrounded by blank lines; ensure the two list items
remain unchanged and keep parallel grammar for "Interactive agents" and
"Background agents".
- Around line 28-35: Revise the two flow descriptions to use shorter, clearer
sentences: in the Interactive agents line that mentions the OAuth
"authorization_code" grant with PKCE, replace "obtain access tokens" with a
shorter phrase like "get access tokens" and keep the sentence concise; for
Background agents (CIBA) split the long sentence into two and simplify the
verbage around starting auth and consent—e.g., state "Background agents use CIBA
(Client Initiated Backchannel Authentication). This lets an agent start
authentication out-of-band (e.g., email or SMS) and get user consent
asynchronously." Reference the existing terms "authorization_code", "PKCE", and
"CIBA" when updating the text.
- Around line 23-34: The markdown has lists that start immediately after
paragraph text causing markdownlint MD032; update the sections for "Interactive
agents" and "Background agents" so each bulleted list is preceded and followed
by a blank line (i.e., add an empty line before the "-" list items and an empty
line after the list blocks) to satisfy MD032; verify the bullets under the
"Interactive agents" and "Background agents" headings remain bulleted (not
numbered) per guidelines and re-run lint to confirm warnings are resolved.
---
Nitpick comments:
In `@en/includes/guides/agentic-ai/ai-agents/register-and-manage-agents.md`:
- Around line 81-83: Update the two CIBA configuration bullets for
"Authentication Request Expiry Time" and "Notification Channels" to include
default values, types/constraints, allowed values and a minimal example: for
Authentication Request Expiry Time (mention the default seconds, type integer,
allowed range e.g., 60–86400 and when to change it) and for Notification
Channels (list allowed values: Email, SMS, Both, default value, type enum/string
and an example usage), and ensure the text follows the doc guideline to state
what the setting controls, default, constraints, example, and guidance on when
to change it.
🪄 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: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 3c3b6b2c-f2a8-492b-a4fa-2140c00bceda
📒 Files selected for processing (1)
en/includes/guides/agentic-ai/ai-agents/register-and-manage-agents.md
|
|
||
| ## Understanding agent types | ||
|
|
||
| {{ product_name }} supports two categories of AI agents based on whether they require user authentication: |
There was a problem hiding this comment.
| {{ product_name }} supports two categories of AI agents based on whether they require user authentication: | |
| {{ product_name }} supports two categories of AI agents based on whether they require user authentication. |
|
|
||
| Agents with user login come in two variants: | ||
|
|
||
| **Interactive agents**: These agents require constant user interaction throughout their operation. Examples include: |
|
|
||
| Interactive agents use the OAuth `authorization_code` grant flow with PKCE (Proof Key for Code Exchange) to authenticate users and get access tokens. | ||
|
|
||
| **Background agents**: These agents perform tasks on behalf of users but operate asynchronously without requiring constant user interaction. Examples include: |
| - **Background agents**: Configured with `urn:openid:params:grant-type:ciba` (Client Initiated Backchannel Authentication) grant type | ||
|
|
||
| The success screen will display the Agent ID, Agent Secret (masked), and for agents with user login, the OAuth Client ID which can be used for OAuth/OIDC flows. | ||
|
|
There was a problem hiding this comment.
shall we add a screenshot of the "success screen"?
2 participants
This update adds comprehensive documentation for the new agent creation feature that allows users to enable user
login for agents. When enabled, the system automatically creates an OAuth/OIDC application to handle user
authentication flows.
Key changes:
This aligns with the agent creation wizard's "Allow users to log in to this agent" checkbox and supports both
interactive agents (authorization code flow) and background agents (CIBA flow).