Skip to content

docs(architecture): add enterprise identity federation doc and update git workflow rules#975

Open
sriaradhyula wants to merge 11 commits intomainfrom
prebuild/docs/enterprise-identity-federation
Open

docs(architecture): add enterprise identity federation doc and update git workflow rules#975
sriaradhyula wants to merge 11 commits intomainfrom
prebuild/docs/enterprise-identity-federation

Conversation

@sriaradhyula
Copy link
Member

Summary

  • Add docs/docs/architecture/enterprise-identity-federation.md — architecture document covering OAuth 2.0 Token Exchange (RFC 8693), On-Behalf-Of (OBO) delegation, Keycloak integration, and the chain-of-trust design for CAIPE agents acting on behalf of authenticated users
  • Update CLAUDE.md git workflow section to document the git worktree approach and corrected prebuild/<type>/<description> branch naming convention
  • Update .cursorrules Development Workflow section with worktree commands and correct branch name examples
  • Update .specify/.cursorrules with a Git Worktree Workflow section under Development Standards
  • Add .specify/specs/enterprise-identity-federation-docs.md tracking this change

Test plan

  • Confirm docs/docs/architecture/enterprise-identity-federation.md renders correctly in Docusaurus
  • Verify all three rules files consistently show prebuild/<type>/... branch naming
  • CI passes

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

1 similar comment
@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@sriaradhyula sriaradhyula added documentation Improvements or additions to documentation Architecture System and Solution Architecture labels Mar 12, 2026
@sriaradhyula sriaradhyula added this to the 0.3.0 milestone Mar 12, 2026
@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 41.6% 7339/17639 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 40.9% 7412/18139 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 40.9% 7412/18139 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

… git workflow rules

Add the Enterprise Identity Federation and User Impersonation architecture
document to docs/docs/architecture/, covering OAuth 2.0 Token Exchange (RFC
8693), OBO delegation, Keycloak integration, and the full chain-of-trust
design for CAIPE agents acting on behalf of authenticated users.

Also update CLAUDE.md, .cursorrules, and .specify/.cursorrules to reflect the
git worktree-based development workflow and the corrected branch naming
convention: prebuild/<type>/<description> (e.g. prebuild/docs/enterprise-identity-federation).

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
…ederation doc

The document referenced 'Pattern 2' without defining other patterns,
making the label confusing. Replaced all instances with the architectural
name each reference already used: 'One-Time User Consent with Identity Linking'.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Replace all organization-specific references with generic equivalents:
- sri@cisco.com → user@example.com
- cisco.okta.com → your-org.okta.com
- @Sri-GH@myusername
- 'Cisco Okta SSO' → 'Enterprise IdP (Okta)'
- '(e.g., Cisco)' prose removed; reframed as generic enterprise environment

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
…eric placeholders

Replace the Keycloak identity provider JSON config block with fully generic
placeholders so the document reads as reference architecture rather than a
Cisco-specific runbook:
- alias: okta-enterprise → enterprise-idp
- displayName: 'Enterprise IdP (Okta)' kept, example clarified
- all URLs: your-org.okta.com → <idp-domain>
- clientId: caipe-keycloak-client → <keycloak-client-id>
- clientSecret vault key: okta-client-secret → idp-client-secret
- matching alias filter in Python snippet updated to enterprise-idp

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Rules changes (CLAUDE.md, .cursorrules, .specify/.cursorrules removal)
extracted to prebuild/chore/git-worktree-workflow-rules (PR #976).
This branch now contains only the architecture doc and spec.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
…agrams

Add two new architecture docs with Mermaid diagrams:

- slack-bot-authorization.md: End-to-end authorization topology, pre-authorization
  identity binding (Okta→Keycloak), runtime token exchange sequence with 4 scope
  validation gates, multi-agent scope isolation, JWT delegation chain, and error
  recovery flows. Clearly labels WebSocket (Socket Mode) for Slack↔Bot and A2A
  Protocol for Bot↔CAIPE communication.

- slack-io-guardrails.md: Input/output guardrail architecture for the Slack bot
  pipeline. Input guardrails (length, secrets, PII, prompt injection, content
  policy) and output guardrails (credential scan, PII leak, hallucination markers,
  content safety, format sanitization) with pluggable chain pattern, configuration
  schema, and observability/metrics integration.

Also adds both docs plus enterprise-identity-federation to the docs sidebar, and
cross-references the authorization diagrams from the federation doc.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
…tt chart

Converts the CAIPE Architecture Evolution slide into a Docusaurus markdown
page with a Mermaid Gantt chart covering the roadmap from static distributed
agents through dynamic/single unification and persona-based profiles.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
Spec 096: policy engine comparison (Cedar, CEL, Casbin, OPA/Rego),
AgentGateway/Keycloak/Slack-Webex external authz research, and supporting
architecture docs (identity federation, Slack authorization and I/O
guardrails, architecture evolution) consolidated under docs/docs/specs.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
Rename docs/docs/specs/096-policy-engine-comparison to
093-agent-enterprise-identity; update spec number (093), feature branch
name, and research context lines.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
…mparison

Keep git branch name unchanged for the open PR; document spec folder slug
093-agent-enterprise-identity in the same line.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
Fold documentation-site and contributor-workflow checklist from former
095-enterprise-identity-federation-docs into 093 spec.md and README.
Remove redundant 095 spec file.

Signed-off-by: Sri Aradhyula <sraradhy@cisco.com>
Made-with: Cursor
@sriaradhyula sriaradhyula force-pushed the prebuild/docs/enterprise-identity-federation branch from 7f5642c to a11d743 Compare March 24, 2026 00:17
@github-actions
Copy link
Contributor

✅ No proprietary content detected. This PR is clear for review!

@github-actions
Copy link
Contributor

📊 Test Coverage Report

Main Tests Coverage

Metric Coverage Details
Lines 39.9% 7495/18790 lines
Branches 0.0% 0/0 branches

📁 Coverage Artifacts

  • Main tests: coverage-reports-main artifact
  • RAG tests: coverage-reports-rag artifact (not available)
  • Download artifacts to view detailed HTML coverage reports

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

Labels

Architecture System and Solution Architecture documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

1 participant