Skip to content

docs: finish the SAML metadata-URL pass - #637

Merged
eseidel merged 1 commit into
mainfrom
docs/saml-metadata-followups
Aug 29, 2026
Merged

docs: finish the SAML metadata-URL pass#637
eseidel merged 1 commit into
mainfrom
docs/saml-metadata-followups

Conversation

@eseidel

@eseidel eseidel commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

#635 switched the ask from four values to a metadata URL, but left a few
spots on the page still written for the old ask.

  • The intro ("gather the values described below") and the multi-domain
    bullet ("send the values for each one") still describe a list of values.
  • The note about members who already have a Google/Microsoft account at
    the domain had ended up inside the "If your IdP publishes no metadata
    URL" subsection, so it read as applying only to that fallback path. It
    applies to every connection — moved back up under the two-item ask.
  • Okta step 6 still led with View SAML setup instructions, and offered
    the metadata link as the alternative. Now the other way round.
  • Certificate rotation said Shorebird "will re-read your metadata", which
    is not true for a connection created from hand-entered values.

Two things added from the landed admin behavior: importing keeps every
signing certificate the metadata lists, so a customer who publishes the
new certificate alongside the old one before the switch can rotate with
no downtime; and the fallback table's Okta column is now labeled as an
example, since that section is aimed at providers that publish no
metadata URL.

Verified against web/apps/admin/app/routes/saml._index.tsx and
saml-metadata.server.ts: the import dialog takes a metadata URL or
pasted XML, so the page's "send the XML file itself" fallback is
accurate.

Prettier and cspell pass. Vale isn't installed in this checkout, so it
did not run; no headings changed.

The metadata-URL change in #635 left a few spots still framed around the
old "send us four values" ask:

- The intro and the multi-domain bullet still said "the values".
- The note about members with existing Google/Microsoft accounts had
  ended up inside the no-metadata-URL subsection, so it read as applying
  only to that path. It applies to everyone; moved it back up.
- Okta step 6 still led with "View SAML setup instructions" rather than
  the metadata link.
- Certificate rotation said Shorebird re-reads your metadata, which is
  not true for a connection created from hand-entered values.

Also documents that Shorebird keeps every signing certificate the
metadata lists, so publishing the new certificate alongside the old one
makes a rotation a non-event, and labels the fallback table's Okta
column as an example, since that section is aimed at providers that
publish no metadata URL.
@eseidel
eseidel requested a review from easymac August 29, 2026 05:29
@eseidel
eseidel enabled auto-merge (squash) August 29, 2026 05:30
@eseidel
eseidel merged commit 6acab0b into main Aug 29, 2026
5 checks passed
@eseidel
eseidel deleted the docs/saml-metadata-followups branch August 29, 2026 06:06
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.

2 participants