Skip to content

dashboard: permissions for setting up SSO #21837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2025
Merged

dashboard: permissions for setting up SSO #21837

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
511d04a
dashboard: permissions for setting up SSO
dveeden Sep 25, 2025
983cdaa
move the note to step3 where the option is mentioned
qiancai Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions dashboard/dashboard-session-sso.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ TiDB Dashboard supports [OIDC](https://openid.net/connect/)-based Single Sign-On

### Enable SSO

> **Note:**
>
> The **Enable to use SSO when sign into TiDB Dashboard** option will be greyed out if the account doesn't have the `SYSTEM_VARIABLES_ADMIN` permission. See [TiDB Dashboard User Management](/dashboard/dashboard-user.md) for more details on permissions.
Copy link

@gemini-code-assist gemini-code-assist bot Sep 25, 2025

Choose a reason for hiding this comment

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

medium

Thanks for adding this helpful note. To improve clarity and align with the documentation style guide, I suggest a few revisions:123

  • Use second person: Address the user as "you" (e.g., "if your account does not have...").
  • Use present tense: The option "is grayed out", not "will be greyed out".
  • Formatting: UI option names should be in backticks, not bold.
  • Wording: "signing in to" is preferred over "sign into" for grammatical correctness and consistency across the documentation.

Here is a suggested update:

Suggested change
> The **Enable to use SSO when sign into TiDB Dashboard** option will be greyed out if the account doesn't have the `SYSTEM_VARIABLES_ADMIN` permission. See [TiDB Dashboard User Management](/dashboard/dashboard-user.md) for more details on permissions.
> The `Enable to use SSO when signing in to TiDB Dashboard` option is grayed out if your account does not have the `SYSTEM_VARIABLES_ADMIN` permission. For more details on permissions, see [TiDB Dashboard User Management](/dashboard/dashboard-user.md).

Style Guide References

Footnotes

  1. The style guide recommends addressing users in the second person ('you'). The current text uses 'the account', which can be improved by changing it to 'your account'. ↩

  2. The style guide prefers using the present tense. The phrase 'will be greyed out' should be changed to the present tense 'is grayed out'. ↩

  3. According to the style guide, UI option names should be enclosed in backticks for consistency. The option name should be changed from bold to backticked. ↩


1. Sign into TiDB Dashboard.

2. Click the username in the left sidebar to access the configuration page.
Expand Down