Skip to content

Latest commit

 

History

History
221 lines (128 loc) · 9.97 KB

manage-user-access.md

File metadata and controls

221 lines (128 loc) · 9.97 KB
title summary
Manage Console User Access
Learn how to manage the user access of the TiDB Cloud console.

Manage Console User Access

This document describes how to manage user access of the TiDB Cloud console.

Sign in

  1. Go to the TiDB Cloud login page: https://tidbcloud.com.

  2. On the TiDB Cloud login page, sign in with Google, GitHub, or email.

Sign out

In the upper-right corner of the TiDB Cloud console, click your account name and select Logout.

Manage user passwords

Note:

The content in this section is only applicable to TiDB Cloud registration with email and password. If you sign up for TiDB Cloud with Google or GitHub, your password is managed by Google or GitHub and you cannot change it using the TiDB Cloud console.

The password for TiDB Cloud account must meet the following requirements:

  • The password must be at least 8 characters in length.
  • The password must contain at least 1 uppercase letter, 1 lowercase letter, and 1 number.

To improve your system security, if you sign up for TiDB Cloud with email and password, it is recommended that you reset your password every 90 days.

To change the password, take the following steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Account.

  3. Click the Change Password tab.

  4. Click Change Password, and then check your mail box for the link to reset the password.

Note:

The new password must not be the same as any of the previous four passwords.

If your password is not changed within 90 days, you will get a prompt to reset your password when you log in to TiDB Cloud. It is recommended that you follow the prompt to reset the password.

Manage user profiles

In TiDB Cloud, you can easily manage your profile, including your first name, last name, and phone number.

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Account. The Profile tab is selected by default.

  3. Update the profile information, and then click Save.

View the organization and project

TiDB Cloud provides a hierarchical structure based on organizations and projects to facilitate the management of your TiDB cluster. In the hierarchy of organizations and projects, an organization can contain multiple projects and organization members, and a project can contain multiple clusters and project members.

Under this structure:

  • Billing occurs at the organization level, while retaining visibility of usage in each project and cluster.

  • You can view all members in your organization.

  • You can also view all members in your project.

To access a cluster in a project under an organization, a user must be both a member of the organization and a member of the project. Organization owners can invite users to join the project to create and manage clusters in the project.

To view which organizations you belong to, perform these steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.
  2. Select Switch Organization in the drop-down menu, and you can see all the organizations you belong to in the submenu.

To check which project you belong to, perform these steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.
  2. Click Organization Settings. The Projects tab is displayed by default.

Switch between organizations

If you are a member of multiple organizations, you can switch your account between organizations.

To switch between organizations, perform these steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.
  2. Select Switch Organization in the drop-down menu, and click the organization you want to switch to.

Invite an organization member

If you are the owner of an organization, you can invite organization members. Otherwise, skip this section.

To invite a member to an organization, perform the following steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Organization Settings. The organization settings page is displayed.

  3. Click User Management, and then select the By All Users tab.

  4. Click Invite.

  5. Enter the email address of the user to be invited, select a role for the user, and then choose a project for the user.

    Tip:

    If you want to invite multiple members at one time, you can enter multiple email addresses.

  6. Click Confirm. Then the new user is successfully added into the user list. At the same time, an email is sent to the invited email address with a verification link.

  7. After receiving this email, the user needs to click the link in the email to verify the identity, and a new page shows.

  8. If the invited email address has not been signed up for a TiDB Cloud account, the user is directed to the sign-up page to create an account. If the email address has been signed up for a TiDB Cloud account, the user is directed to the sign-in page, and after sign-in, the account joins the organization automatically.

Note:

The verification link in the email will expire in 24 hours. If your user doesn't receive the email, click Resend.

Invite a project member

If you are the owner of an organization, you can invite project members. Otherwise, skip this section.

To invite a member to a project, perform the following steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Organization Settings. The organization settings page is displayed.

  3. Click User Management, and then select the By Project tab.

  4. Click Invite.

  5. Enter the email address of the user to be invited, select a role for the user, and then choose a project for the user.

    Tip:

    If you want to invite multiple members at one time, you can enter multiple email addresses.

  6. Click Confirm. Then the new user is successfully added into the user list. At the same time, an email is sent to the invited email address with a verification link.

  7. After receiving this email, the user needs to click the link in the email to verify the identity, and a new page shows.

  8. On the new page, the user needs to view and agree with our license, and then click Submit to create the account in TiDB Cloud. After that, the user is redirected to the login page.

Note:

The verification link in the email will expire in 24 hours. If your user doesn't receive the email, click Resend.

Configure member roles

If you are the owner of an organization, you can perform the following steps to configure roles for your organization members:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.
  2. Click Organization Settings. The organization settings page is displayed.
  3. Click User Management, and then select the By All Users tab.
  4. Click the role of the target member, and then modify the role.

There are four roles in an organization. The permissions of each role are as follows:

Permission Owner Member Billing Admin Audit Admin
Invite members to join the organization, and remove members from the organization ✅ ❌ ❌ ❌
Set roles for an organization member ✅ ❌ ❌ ❌
Create and rename projects ✅ ❌ ❌ ❌
Invite members to join a project, and remove members from a project ✅ ❌ ❌ ❌
Edit time zone ✅ ❌ ❌ ❌
View bills and edit payment information ✅ ❌ ✅ ❌
View and configure audit logging ❌ ❌ ❌ ✅
Obtain project instance management rights ✅ ✅ ✅ ✅
Manage an API key ✅ ❌ ❌ ❌

Remove an organization member

If you are the owner of an organization, you can remove organization members. Otherwise, skip this section.

To remove a member from an organization, perform the following steps:

Note:

If a member is removed from an organization, the member is removed from the belonged projects either.

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Organization Settings. The organization settings page is displayed.

  3. Click By All Users.

  4. Click Delete in the user row that you want to delete.

Remove a project member

If you are the owner of an organization, you can remove project members. Otherwise, skip this section.

To remove a member from a project, perform the following steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Organization Settings. The organization settings page is displayed.

  3. Click By Project.

  4. Click Delete in the user row that you want to delete.

Set the local time zone

If you are the organization owner, you can modify the system display time according to your time zone.

To change the local timezone setting, perform the following steps:

  1. Click the account name in the upper-right corner of the TiDB Cloud console.

  2. Click Organization Settings. The organization settings page is displayed.

  3. Click Time Zone.

  4. Click the drop-down list and select your time zone.

  5. Click Confirm.