Skip to content

cloud: clarify SAML configuration flow - #23842

Open
qiancai wants to merge 1 commit into
pingcap:release-8.5from
qiancai:clarify-saml-steps
Open

cloud: clarify SAML configuration flow#23842
qiancai wants to merge 1 commit into
pingcap:release-8.5from
qiancai:clarify-saml-steps

Conversation

@qiancai

@qiancai qiancai commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Clarify the SAML configuration workflow for TiDB Cloud Organization SSO. The updated steps explain how to use the Entity ID and Postback URL provided by TiDB Cloud to configure the SAML application in the identity provider before entering the IdP Sign on URL and Signing Certificate in TiDB Cloud.

The update also identifies the Postback URL as the SAML endpoint, also known as the ACS URL or Reply URL, and covers the case where an organization's SSO team manages the identity provider.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Reordered the SAML authentication setup steps to clarify when to copy TiDB Cloud values and configure the identity provider.
    • Updated the final action from Save to Activate.

@ti-chi-bot

ti-chi-bot Bot commented Sep 12, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign csuzhangxc for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 12, 2026
@qiancai qiancai self-assigned this Sep 12, 2026
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Sep 12, 2026
@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 58c38592-22bb-4148-85f1-6b3f0c0053c4

📥 Commits

Reviewing files that changed from the base of the PR and between 8d85871 and 4f63c33.

📒 Files selected for processing (1)
  • tidb-cloud/tidb-cloud-org-sso-authentication.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The SAML configuration procedure now starts with TiDB Cloud-provided values, uses them to configure the identity provider application, retrieves the IdP values afterward, and changes the final button label from Save to Activate.

Changes

SAML setup procedure

Layer / File(s) Summary
SAML configuration sequence
tidb-cloud/tidb-cloud-org-sso-authentication.md
The procedure now retrieves the Entity ID and Postback URL from TiDB Cloud before configuring the IdP application. It then retrieves the Sign on URL and Signing Certificate and uses Activate as the final action.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 4f63c

The revised SAML setup sequence and Activate label are ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the main change: clarifying the SAML configuration flow.
Description check ✅ Passed The description explains the documentation changes, affected TiDB version, reference link, AI involvement, and applicable change categories. The required sections are substantially complete.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 12, 2026
@qiancai qiancai added missing-translation-status This PR does not have translation status info. ONCALL Relates to documentation oncall. labels Sep 12, 2026
@qiancai qiancai changed the title docs: clarify SAML configuration flow cloud: clarify SAML configuration flow Sep 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. missing-translation-status This PR does not have translation status info. ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant