Skip to content

cloud: merge premium IAM into shared user access docs #22799

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
qiancai merged 12 commits into from
Apr 29, 2026
Merged

cloud: merge premium IAM into shared user access docs #22799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b53f0b5
Add TOC-tidb-cloud-premium.md (#21772)
lilin90 Sep 12, 2025
f96919d
Premium V1 change #21790
qqqdan Sep 17, 2025
cacdf46
*: update premium for preview (#21789)
lilin90 Sep 17, 2025
8f3b33b
chore: sync with release-8.5
qiancai Apr 15, 2026
b9cde78
Merge branch 'release-8.5' into feature/preview-premium
qiancai Apr 15, 2026
39f9369
Merge branch 'release-8.5' into feature/preview-premium
Oreoxmt Apr 20, 2026
2a3c1a0
develop: add documents for TiDB Cloud Premium (#22533)
Icemap Apr 23, 2026
cab2df4
merge premium iam into shared cloud docs
qiancai Apr 24, 2026
cf84ad6
Update _index.md
qiancai Apr 24, 2026
423419b
update the steps to get project ID
qiancai Apr 29, 2026
bcbc462
Merge branch 'release-8.5' into user-access-premium
Oreoxmt Apr 29, 2026
cb93c86
Merge branch 'release-8.5' into user-access-premium
Oreoxmt Apr 29, 2026
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
2 changes: 1 addition & 1 deletion TOC-tidb-cloud-premium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
- [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md)
- [Standard SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md)
- [Organization SSO Authentication](/tidb-cloud/tidb-cloud-org-sso-authentication.md)
- [Identity Access Management](/tidb-cloud/premium/manage-user-access-premium.md)
- [Identity Access Management](/tidb-cloud/manage-user-access.md)
- [OAuth 2.0](/tidb-cloud/oauth2.md)
- Network Access Control
- [Configure an IP Access List](/tidb-cloud/premium/configure-ip-access-list-premium.md)
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/key-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ TiDB Cloud Dedicated lets you adjust its compute and storage resources separatel

TiDB Cloud ensures high availability in all supported plans:

- For <CustomContent plan="starter,essential">{{{ .starter }}} and {{{ .essential }}}</CustomContent> <CustomContent plan="premium">{{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}}</CustomContent>, see [High Availability in TiDB Cloud](/tidb-cloud/serverless-high-availability.md).
- For {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}}, see [High Availability in TiDB Cloud](/tidb-cloud/serverless-high-availability.md).
- For TiDB Cloud Dedicated, see [High Availability in TiDB Cloud Dedicated](/tidb-cloud/high-availability-with-multi-az.md).

## Monitoring
Expand Down
8 changes: 2 additions & 6 deletions tidb-cloud/manage-projects-and-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can discover, access, a

A TiDB Cloud resource is a deployable unit that you can manage. It can be one of the following:

- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a <CustomContent plan="starter,essential,dedicated">{{{ .starter }}} or Essential</CustomContent><CustomContent plan="premium">{{{ .starter }}}, Essential, or Premium</CustomContent> instance
- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, or Premium instance
- A {{{ .dedicated }}} cluster

### TiDB Cloud projects
Expand Down Expand Up @@ -43,12 +43,8 @@ For more information, see the following documents:

- [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md)

<CustomContent plan="premium">

- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md)

</CustomContent>

- [Create a {{{ .dedicated }}} Cluster](/tidb-cloud/create-tidb-cluster.md)

### Manage TiDB Cloud resources
Expand Down Expand Up @@ -144,4 +140,4 @@ To move a TiDB X instance, take the following steps:
- To move the TiDB X instance to a project, select **To a project**, and then select the target project from the drop-down list.
- To move the TiDB X instance out of any project, select **Outside any project**.

4. Click **Move**.
4. Click **Move**.
17 changes: 10 additions & 7 deletions tidb-cloud/manage-user-access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ Before accessing TiDB Cloud, [create a TiDB Cloud account](https://tidbcloud.com

TiDB Cloud uses a hierarchical structure based on organizations, projects, and resources to help you manage users and TiDB deployments.

- An organization is a top-level entity (such as a company or a customer) that you use to manage your TiDB Cloud accounts (including a management account with any number of member accounts), [projects](#projects), and [resources](/tidb-cloud/tidb-cloud-glossary.md#tidb-cloud-resource).
- A project is a container for TiDB Cloud resources.
- A [resource](/tidb-cloud/tidb-cloud-glossary.md#tidb-cloud-resource) in TiDB Cloud can be either a TiDB X instance or a {{{ .dedicated }}} cluster. A TiDB X instance is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, or Premium instance.

- For {{{ .starter }}} and Essential instances, a project is an optional logical container, which means you can either group these instances in a project or keep these instances at the organization level.
- A [project](/tidb-cloud/tidb-cloud-glossary.md#project) is a container for TiDB Cloud resources.

- For TiDB X instances, a project is an optional logical container, which means you can either group these instances in a project or keep these instances at the organization level.
- For {{{ .dedicated }}} clusters, a project is infrastructure-bound and required, which means {{{ .dedicated }}} clusters must be grouped in projects for management purposes.
- A resource in TiDB Cloud can be either a TiDB X instance (for example, {{{ .starter }}} or {{{ .essential }}}) or a {{{ .dedicated }}} cluster.

- An organization is a top-level entity (such as a company or a customer) that you use to manage your TiDB Cloud accounts (including a management account with any number of member accounts), projects, and resources.

If you are an organization owner, you can create multiple projects in your organization.

Expand All @@ -36,6 +38,7 @@ The following is an example of the hierarchical structure:
- {{{ .starter }}} instance 2
- {{{ .starter }}} instance 3
- {{{ .essential }}} instance 2
- {{{ .premium }}} instance 1
- TiDB Dedicated project 1
- {{{ .dedicated }}} cluster 1
- {{{ .dedicated }}} cluster 2
Expand Down Expand Up @@ -71,8 +74,8 @@ A project groups and manages TiDB Cloud resources.
In TiDB Cloud, there are three types of projects:

- **TiDB Dedicated project**: This project type is used only for {{{ .dedicated }}} clusters. It helps you manage settings for {{{ .dedicated }}} clusters separately by project, such as RBAC, networks, maintenance, alert subscriptions, and encryption access.
- **TiDB X project**: This project type is used only for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page.
- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API.
- **TiDB X project**: This project type is used only for TiDB X instances (including {{{ .starter }}}, Essential, and Premium instances). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page.
- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API.

The following table lists the differences between these project types:

Expand Down Expand Up @@ -149,7 +152,7 @@ TiDB X instances support instance-level roles so that you can grant access to a

> **Note:**
>
> - Instance roles apply only to {{{ .starter }}} and {{{ .essential }}}. TiDB Cloud Dedicated clusters do not support instance roles.
> - Instance roles apply only to {{{ .starter }}}, Essential, and Premium instances. TiDB Cloud Dedicated clusters do not support instance roles.
> - `Organization Owner` automatically has all permissions for all TiDB X instances in the organization.
> - Each instance role inherits all the permissions of the `Organization Viewer` role by default.
> - Project roles and instance roles are additive. A user can inherit access from a project role and also have a more specific role on an individual instance.
Expand Down
84 changes: 42 additions & 42 deletions tidb-cloud/premium/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,129 +9,129 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings

<LearningPath label="Learn" icon="cloud1">

[Why TiDB Cloud](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=premium)
[Why TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=premium)

[Key Concepts](https://docs-preview.pingcap.com/tidbcloud/key-concepts/?plan=premium)
[Key Concepts](https://docs.pingcap.com/tidbcloud/key-concepts/?plan=premium)

[FAQ](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=premium)
[FAQ](https://docs.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=premium)

</LearningPath>

<LearningPath label="Try" icon="cloud5">

[Try Out TiDB Cloud](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=premium)
[Try Out TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=premium)

[Try Out TiDB + AI](https://docs-preview.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=premium)
[Try Out TiDB + AI](https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=premium)

[Try Out HTAP](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=premium)
[Try Out HTAP](https://docs.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=premium)

[Try Out TiDB Cloud CLI](https://docs-preview.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium)
[Try Out TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium)

</LearningPath>

<LearningPath label="Develop" icon="doc8">

[Developer Guide Overview](https://docs-preview.pingcap.com/tidbcloud/dev-guide-overview/?plan=premium)
[Developer Guide Overview](https://docs.pingcap.com/tidbcloud/dev-guide-overview/?plan=premium)

[Quick Start](https://docs-preview.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=premium)
[Quick Start](https://docs.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=premium)

[Example Application](https://docs-preview.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=premium)
[Example Application](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=premium)

</LearningPath>

<LearningPath label="Maintain" icon="cloud7">

[Create a {{{ .premium }}} Instance](https://docs-preview.pingcap.com/tidbcloud/create-tidb-instance-premium/?plan=premium)
[Create a {{{ .premium }}} Instance](https://docs.pingcap.com/tidbcloud/create-tidb-instance-premium/?plan=premium)

[Connect to a {{{ .premium }}} Instance](https://docs-preview.pingcap.com/tidbcloud/connect-to-tidb-instance/?plan=premium)
[Connect to a {{{ .premium }}} Instance](https://docs.pingcap.com/tidbcloud/connect-to-tidb-instance/?plan=premium)

[Use an HTAP Cluster](https://docs-preview.pingcap.com/tidbcloud/tiflash-overview/?plan=premium)
[Use an HTAP Cluster](https://docs.pingcap.com/tidbcloud/tiflash-overview/?plan=premium)

[Back Up and Restore Data](https://docs-preview.pingcap.com/tidbcloud/backup-and-restore-premium/?plan=premium)
[Back Up and Restore Data](https://docs.pingcap.com/tidbcloud/backup-and-restore-premium/?plan=premium)

[Use API (Beta)](https://docs-preview.pingcap.com/tidbcloud/api-overview/?plan=premium)
[Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview/?plan=premium)

[Use TiDB Cloud CLI](https://docs-preview.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium)
[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium)

</LearningPath>

<LearningPath label="Migrate" icon="cloud3">

[From Amazon RDS for Oracle](https://docs-preview.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=premium)
[From Amazon RDS for Oracle](https://docs.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=premium)

[Import Sample Data](https://docs-preview.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=premium)
[Import Sample Data](https://docs.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=premium)

[Import CSV Files](https://docs-preview.pingcap.com/tidbcloud/import-csv-files-premium/?plan=premium)
[Import CSV Files](https://docs.pingcap.com/tidbcloud/import-csv-files-premium/?plan=premium)

[Import Parquet Files](https://docs-preview.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=premium)
[Import Parquet Files](https://docs.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=premium)

[With MySQL CLI](https://docs-preview.pingcap.com/tidbcloud/import-with-mysql-cli-premium/?plan=premium)
[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli-premium/?plan=premium)

</LearningPath>

<LearningPath label="Monitor" icon="cloud6">

[Status and Metrics](https://docs-preview.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=premium)
[Status and Metrics](https://docs.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=premium)

[Built-in Monitoring](https://docs-preview.pingcap.com/tidbcloud/built-in-monitoring-premium/?plan=premium)
[Built-in Monitoring](https://docs.pingcap.com/tidbcloud/built-in-monitoring-premium/?plan=premium)

</LearningPath>

<LearningPath label="Tune" icon="tidb-cloud-tune">

[Tuning Overview](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=premium)
[Tuning Overview](https://docs.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=premium)

[Analyze Performance](https://docs-preview.pingcap.com/tidbcloud/tune-performance/?plan=premium)
[Analyze Performance](https://docs.pingcap.com/tidbcloud/tune-performance/?plan=premium)

[Tune SQL Performance](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=premium)
[Tune SQL Performance](https://docs.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=premium)

[Tune TiFlash Performance](https://docs-preview.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=premium)
[Tune TiFlash Performance](https://docs.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=premium)

</LearningPath>

<LearningPath label="Security" icon="users">

[Password Authentication](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=premium)
[Password Authentication](https://docs.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=premium)

[User Roles](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#user-roles)
[User Roles](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#user-roles)

[Manage User Profiles](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#manage-user-profiles)
[Manage User Profiles](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#manage-user-profiles)

[Manage Organization Access](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#manage-organization-access)
[Manage Organization Access](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#manage-organization-access)

[Configure an IP Access List](https://docs-preview.pingcap.com/tidbcloud/configure-ip-access-list-premium/?plan=premium)
[Configure an IP Access List](https://docs.pingcap.com/tidbcloud/configure-ip-access-list-premium/?plan=premium)

</LearningPath>

<LearningPath label="Billing" icon="cloud2">

[Pricing](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#pricing-for-premium)
[Pricing](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#pricing-for-premium)

[Invoices](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#invoices)
[Invoices](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#invoices)

[Credits](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#credits)
[Credits](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#credits)

</LearningPath>

<LearningPath label="Integrations" icon="cloud4">

[Airbyte](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=premium)
[Airbyte](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=premium)

[Zapier](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=premium)
[Zapier](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=premium)

[Vercel](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=premium)
[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=premium)

[Terraform](https://docs-preview.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=premium)
[Terraform](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=premium)

[Amazon AppFlow](https://docs-preview.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=premium)
[Amazon AppFlow](https://docs.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=premium)

</LearningPath>

<LearningPath label="Reference" icon="cloud-dev">

[SQL Reference](https://docs-preview.pingcap.com/tidbcloud/basic-sql-operations/?plan=premium)
[SQL Reference](https://docs.pingcap.com/tidbcloud/basic-sql-operations/?plan=premium)

[System Variables](https://docs-preview.pingcap.com/tidbcloud/system-variables/?plan=premium)
[System Variables](https://docs.pingcap.com/tidbcloud/system-variables/?plan=premium)

</LearningPath>

Expand Down
Loading
Loading