Skip to content

docs: document okta_saml configuration and auth flow - #247

Closed
youngjinjung-linq wants to merge 4 commits into
DevopsArtFactory:mainfrom
youngjinjung-linq:feature/issue-88-okta-saml-docs
Closed

docs: document okta_saml configuration and auth flow#247
youngjinjung-linq wants to merge 4 commits into
DevopsArtFactory:mainfrom
youngjinjung-linq:feature/issue-88-okta-saml-docs

Conversation

@youngjinjung-linq

Copy link
Copy Markdown

Summary

Implements #88, the final slice of the Okta SAML track (#26). Stacked on #246 — merge order: #244#245#246 → this.

  • README: okta_saml context in the config example, a dedicated Okta SAML Contexts usage section (interactive + UNIC_OKTA_USERNAME/UNIC_OKTA_PASSWORD automation), how to derive okta_app_id from the app embed link, and explicit v1 limitations (factor set, deterministic role selection, credentials-only caching).
  • docs/architecture.en.md / docs/architecture.ko.md: okta_saml added to the auth model with the runtime flow and cache behavior; auth mode counts corrected.
  • docs/project-overview.en.md / docs/project-overview.ko.md: auth coverage updated.

With this, all five delivery slices of #26 are complete (#84 schema, #85 exchange, #86 cache, #87 MFA, #88 docs) — #26 can be closed once the stack merges.

Closes #88

Part of #26

YoungJin and others added 4 commits August 13, 2026 17:28
Introduce the okta_saml auth type so Okta-backed contexts can be
defined ahead of runtime credential exchange (DevopsArtFactory#85). Config gains
okta_org_url and okta_app_id fields in both the flat and structured
auth forms, the context add wizard offers okta_saml with non-secret
fields only (passwords and MFA secrets never touch config.yaml), and
the repository/env flows reject okta_saml contexts with a clear
not-implemented-yet error instead of misbehaving.

Closes DevopsArtFactory#84

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BFhLrnpVxivu62cC3k9NZB
Implement runtime credential resolution for okta_saml contexts:
`unic env` performs Okta primary authentication (prompting on stderr
with no-echo password input, or UNIC_OKTA_USERNAME/UNIC_OKTA_PASSWORD
for automation), fetches the SAML assertion from the app embed link,
parses the AWS role/principal pairs, and exchanges the assertion via
sts:AssumeRoleWithSAML. Role selection is deterministic: the context's
role_arn wins, a single role is auto-selected, and multiple roles
without a preference produce an explicit error listing the choices.

Session credentials are cached under ~/.config/unic/cache/okta-saml/
(0700/0600, keyed by org|app|role) until expiry; the Okta password and
session token are never persisted. The TUI passively reuses a valid
cached session and otherwise points at `unic env <context>`. Okta MFA
challenges are rejected with a clear error until DevopsArtFactory#87 lands.

Closes DevopsArtFactory#85
Closes DevopsArtFactory#86

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BFhLrnpVxivu62cC3k9NZB
Handle MFA_REQUIRED during Okta primary authentication with a v1
factor set of TOTP (token:software:totp) and Okta Verify push. TOTP is
preferred when both are enrolled because it completes without waiting;
push sends the notification and polls the verify link (3s interval,
60s timeout) with explicit rejected/timeout/cancel handling. Accounts
with only unsupported factors get an error listing what is available
versus supported, and MFA_ENROLL is reported as no-enrolled-factor.
One-time codes are read interactively and never persisted.

Closes DevopsArtFactory#87

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BFhLrnpVxivu62cC3k9NZB
Document the okta_saml context format, runtime flow, and v1
limitations across README (config example, usage section, env-var
automation), architecture docs (EN/KO auth model), and project
overview docs. v1 limitations are stated explicitly: TOTP and Okta
Verify push factors only, deterministic role selection via role_arn,
and credentials-only caching with no persisted secrets.

Closes DevopsArtFactory#88

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BFhLrnpVxivu62cC3k9NZB
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@youngjinjung-linq, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 13 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: bbc22e0f-0dd9-45e7-a880-d619cc5beaf4

📥 Commits

Reviewing files that changed from the base of the PR and between 744b139 and 64c1b7f.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (16)
  • README.md
  • docs/architecture.en.md
  • docs/architecture.ko.md
  • docs/project-overview.en.md
  • docs/project-overview.ko.md
  • go.mod
  • internal/app/context_add.go
  • internal/app/context_add_test.go
  • internal/auth/env.go
  • internal/auth/okta.go
  • internal/auth/okta_test.go
  • internal/config/config.go
  • internal/config/config_test.go
  • internal/services/aws/okta_saml_cache.go
  • internal/services/aws/okta_saml_cache_test.go
  • internal/services/aws/repository.go

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.

@YoungJinJung

Copy link
Copy Markdown
Contributor

Recreated as #260 from an in-repo branch under the maintainer account; this PR is superseded.

@youngjinjung-linq
youngjinjung-linq deleted the feature/issue-88-okta-saml-docs branch August 13, 2026 23:52
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.

docs: Document okta_saml configuration and auth flow

2 participants