Skip to content

Document SSO connections and correct the access reference - #95

Open
Kn0ax wants to merge 2 commits into
mainfrom
kn0ax/docs-sso-and-access
Open

Kn0ax wants to merge 2 commits into
mainfrom
kn0ax/docs-sso-and-access

Conversation

@Kn0ax

@Kn0ax Kn0ax commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

What

Adds a page on SSO and external identity and corrects the access reference where it had drifted from the product.

New: /docs/sso

  • OpenID Connect and white-label signer connections: where they live (Team settings → Access → SSO providers), the fields, who can manage them.
  • The redirect URI to register at the provider, the flow and accepted ID token algorithms.
  • External grants (Space → Access → Advanced → SSO and identity, sf share identity grant): the subject is the exact sub claim, any role, how to change or revoke.
  • What visitors see, rotation (ends sessions, keeps grants) and revocation (removes grants too).
  • Signer connections are described at a high level; the exchange protocol is not in the public API reference, so the page points to support.

Corrections in /docs/access, /docs/cli/share, /docs/config-file, /docs/api/authentication

  • sf share link create and sf share password create default to viewer, not commenter; commenter on live needs comments set to Everywhere.
  • --network IP/CIDR rules are unsupported and refused on write; --ip on share check reports them as denied.
  • Dashboard Access page: title "Manage access", General access is Private/Public, Path rules / Machine credentials / SSO sit under Advanced.
  • Team Access page: "Space access" card, "New spaces are" row, plus the Private spaces only and Hide from search engines switches.
  • Public grants cannot target branches; a grant takes 100 patterns in total.
  • Passwords need 15+ characters; invitations expire after 7 days.
  • Machine credentials: any role, X-SF-Authorization on the Space vs Authorization on the API.
  • Access requests: form fields, confirmation window, owner/admin email, 25 pending cap, 14-day expiry, default viewer on approve.
  • Access page lanes: Continue with Spacefast and request access are always present; no "email code" lane, verified email is a follow-up step on links and passwords.
  • sf.jsonc access is ignored while Private spaces only is on and cannot be revoked with sf share revoke.
  • Example IDs use the real prefixes (grt_, arq_, per_).

Verification

verify:prose, verify:public-safety, verify:commands, build, verify:routes, and test:docs all pass.

View in Indent
Tag @indent to continue the conversation here.


View with [code]smith Test with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

Add an SSO and external identity page covering OpenID Connect and signer
connections, the redirect URI, external grants, rotation and revocation.
Correct the access and share pages: link and password roles default to
viewer, IP rules are unsupported, public grants cannot target branches,
pattern caps are combined, machine tokens use X-SF-Authorization on the
Space, and the team Private spaces only policy exists.
@indent

indent Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Issues

All clear! No issues remaining. 🎉

3 issues already resolved
  • The identity update docs say only rotating a secret or key set ends sessions, but changing --client-id or --session-ttl also signs out every admitted SSO session. The "30 minutes at most" TTL cap applies only to signer connections, yet the example uses 8h. (fixed by commit 5f0ac36)
    Found by Indent Review Agent
  • The --network row advises --no-network to clear a stale IP rule, but that flag also removes country and user-agent rules, and can't be combined with them in one edit. (fixed by commit 5f0ac36)
    Found by Indent Review Agent
  • The access page doesn't "always" offer Continue with Spacefast and request access: the runtime only adds those lanes on a claimed Space, and renders the uniform deny page otherwise. (fixed by commit 5f0ac36)
    Found by Indent Review Agent

CI Checks

All required CI checks passed on 5f0ac36.

Review agents

Select any unchecked box below to run or rerun that agent.

Passed (1)
  • Indent Review Agent · No remaining issues found
Full results

Indent Review Agent

  • Summary: No remaining issues found
  • Last ran on commit: 5f0ac364
  • Latest result
    {
      "summary": "No remaining issues found",
      "findings": []
    }

@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 47bb56e3-bcc6-4ced-b312-ad82b0ac3c8c
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Comment thread content/cli/share.mdx Resolved
Comment thread content/cli/share.mdx Resolved
Comment thread content/(serve)/access.mdx Resolved

This branch was successfully deployed

1 active deployment
preview/kn0ax/docs-sso-and-access — 5f0ac364 Deployed Oct 30, 2026 by spacefast[bot]
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