Skip to content

Commit 1ad0e32

Browse files
committed
docs: update service account
1 parent 2725514 commit 1ad0e32

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

content/docs/administration/user-groups.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ feature_name: USER_GROUPS
66
`User Group` or simply `Group` contains a set of users. `Group` simplifies access management as you can grant
77
roles to a `Group` instead of granting to the individual users one by one.
88

9-
<HintBlock type="info">
9+
## Constraints
1010

11-
Bytebase does not support nested group. A group can only contain users, it can't contain another group.
12-
13-
</HintBlock>
11+
- Bytebase does not support nested group. A group can only contain users, it can't contain another group.
12+
- You can only add normal user account to the group and can not add service account. Service account within a group is an [anti-pattern](https://cloud.google.com/iam/docs/best-practices-service-accounts#groups).
1413

1514
## Add group
1615

@@ -49,3 +48,9 @@ Now you can see the `Contractor Group` under **View by members** page as well as
4948
![project-members-or-roles](/content/docs/administration/user-groups/project-members-or-roles.webp)
5049

5150
All members within this group now share permission to the project.
51+
52+
## Service account
53+
54+
You can only add normal user account to the group and can not add service account.
55+
56+
Service accounts are designed for application use, with each application typically having unique access needs. Since applications rarely perform identical functions, their required resource access tends to differ, making shared or identical permissions uncommon.

content/docs/api/authentication.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ title: Authentication
1010

1111
## Service Account
1212

13-
You should create service account to interact with the Bytebase API.
13+
A service account is a non-human account used by applications, scripts, or services to access the Bytebase API. The service account follows the same permission model as the normal user account. The only exception
14+
is service account can't be added to a group as it's an [anti-pattern](https://cloud.google.com/iam/docs/best-practices-service-accounts#groups).
1415

1516
In **Users & Groups** under **Security & Policy** section, **Add User** on the upper-right. Choose **Service Account** Type, fill in the email and **Confirm**. Then you can see your service account in the list. **Copy Service Key** right away.
1617

0 commit comments

Comments
 (0)