Skip to content

Add guide for migrating from legacy to v2 custom mapping. - #1612

Open
brookecastleberry wants to merge 12 commits into
mainfrom
docs/custom-mapping-migration
Open

Add guide for migrating from legacy to v2 custom mapping.#1612
brookecastleberry wants to merge 12 commits into
mainfrom
docs/custom-mapping-migration

Conversation

@brookecastleberry

@brookecastleberry brookecastleberry commented Aug 6, 2026

Copy link
Copy Markdown

Documents the legacy custom mapping to v2 custom mapping migration process.


Note

Low Risk
Documentation-only change with no code, security, or data handling impact.

Overview
Adds a new documentation guide that walks customers through migrating their SSO custom role mapping from the legacy dash-delimited format to the v2 colon-delimited snyk:{scope}:{target}:{role} syntax.

The guide covers planning, extracting slugs, configuring the IdP, testing with Snyk Support, production activation, and cleanup. It also adds side-by-side translation tables for Group, Organization, and Tenant-level roles.

The new page is linked from the custom mapping README and added to the platform administration SUMMARY.

Reviewed by Cursor Bugbot for commit cd69009. Bugbot is set up for automated code reviews on this repo. Configure here.

Documents the IdP migration process and syntax translation reference for SSO custom role mapping.

Co-authored-by: Cursor <cursoragent@cursor.com>
@brookecastleberry
brookecastleberry requested a review from a team as a code owner August 6, 2026 18:18
@snyk-io

snyk-io Bot commented Aug 6, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Avoids raw hint syntax rendering issues in the published docs.

Co-authored-by: Cursor <cursoragent@cursor.com>

@VeronicaSnyk VeronicaSnyk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed against the Snyk docs writing rules. Useful page and the syntax translation tables are the strongest part — they will save administrators a lot of guesswork. The comments below are mostly a consistent set of four style patterns rather than one-off errors:

  • Modals — "may", "should", "might" appear seven times. Replace with definite statements, "must", or "can". The one in the access-loss warning matters most: if users without a valid mapping lose access, say so definitively.
  • Future tense and agentless passives — "will validate", "will be updated", "roles are automatically assigned". Name Snyk or the user as the actor and use present tense.
  • Bold scaffolding labels**Note:**, **Warning:**, **Best practice:**, and bolded list lead-ins. Bold is reserved for UI elements and status values; the parent README already uses {% hint %} for these asides, so this page should match.
  • Sentence case — the title, the SUMMARY.md entry, and the README link text all use title case.

Two things worth resolving before the line edits, since they affect the shape of the page:

  1. Naming. The page cycles through "v2 custom mapping", "the new format", "updated custom mapping", and "New custom mapping format" as a column header. More importantly, "v2" does not appear anywhere on the canonical README, which calls it the "updated custom mapping option". Pick one term and make the README agree.
  2. Step structure. Seven manual ### Step N: headings split across two H2s ("Migration IdP configuration process" / "Implementation and rollout") for what is one sequence. Use {% stepper %} / {% step %} under a single H2, and lead with an anchor-linked roadmap of the phases per the implementation-guide template.

Three content questions for the SSO team, flagged inline: Step 1 and Step 5 disagree on whether all mappings or only a few are configured before activation; **Best practice:** in Step 6 labels a statement of fact, so something may have been dropped there; and please confirm Group-level custom roles genuinely had no legacy equivalent.


One process note: if this is not already covered by a /ship-it request from Slack, please create one so the change is tracked through the usual review and release flow.

Comment on lines +26 to +28
## Migration IdP configuration process

### Step 1: Plan and audit

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structure — worth addressing before the line edits. Two issues:

  1. "Migration IdP configuration process" is hard to parse (three nouns stacked). And the split between this H2 (Steps 1–4) and "Implementation and rollout" (Steps 5–7) is arbitrary — it is one sequence, and the second H2 heading does not tell a scanning reader anything the steps do not.
  2. Manual ### Step N: headings duplicate numbering GitBook can render natively. Use {% stepper %} / {% step %} for the whole sequence under one H2 ("Migration process").

Per the implementation-guide template, also add a short anchor-linked roadmap right after the intro — "As you work through this page, you will:" followed by the seven phases — so administrators can see the scope of the migration before starting.

Comment thread platform-administration/SUMMARY.md Outdated
pull Bot pushed a commit to Jason-123-cyber/user-docs that referenced this pull request Aug 13, 2026
Fixes 155 cross-space GitBook links of the form
  app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-cli/snyk-cli/...
which produced the broken public URL
  https://docs.snyk.io/developer-tools/snyk-cli/snyk-cli/...

Root cause: a GitBook Git Sync commit from June 2026 generated
cross-space href attributes with an extra snyk-cli/ path segment.
Prior fix PRs (snyk#1609, snyk#1611, snyk#1612) cleaned up docs.snyk.io-format
URLs but left the app.gitbook.com/s/... internal links untouched.
This pass catches all remaining instances across 84 files in
agent-security, discover-snyk, platform-administration,
scan-fix-and-prevent, and snyk-data-and-governance.

Excludes discover-snyk/whats-new.md (auto-generated).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
brookecastleberry and others added 10 commits August 21, 2026 10:21
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/migrating-from-legacy-to-v2-custom-mapping.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
…tup/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/README.md

Co-authored-by: VeronicaSnyk <136595978+VeronicaSnyk@users.noreply.github.com>
Remove redundant activation language from Step 5 so validation and IdP setup are described separately.

Co-authored-by: Cursor <cursoragent@cursor.com>
@brookecastleberry

Copy link
Copy Markdown
Author

Comment: Three content questions for the SSO team, flagged inline: Step 1 and Step 5 disagree on whether all mappings or only a few are configured before activation; Best practice: in Step 6 labels a statement of fact, so something may have been dropped there; and please confirm Group-level custom roles genuinely had no legacy equivalent

Answers:

  • I updated some of the text in step 5 to make it more clear, but all role claims should be set up prior to full activation (step 6). Step 5 is initially a test of a small number of role claims (no activation needed - Snyk will check in Auth0). Then the suggestion is after validation to finish role claim set up prior to step 6 (full activation).
  • Legacy Custom Mapping did not support group-level custom roles: https://docs.snyk.io/platform-administration/user-management/single-sign-on-sso-for-authentication-to-snyk/custom-mapping/legacy-custom-mapping
  • for step 6 - this isn't necessarily a fact but the Best Practice that teams should follow. They could instead create a new SSO connection to do this migration/activation but that's not what we're recommending.

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