0

Update a service account

by
Published Oct 17, 2025

To manage roles associated with a service account after creation, pass the service_account_id instead of a user_id to any [Role Management endpoint](#tag--Role-Management). Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Script cockroachdb Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Cockroachdb = {
3
  token: string;
4
};
5
/**
6
 * Update a service account
7
 * To manage roles associated with a service account after creation, pass the service_account_id instead of a user_id to any [Role Management endpoint](#tag--Role-Management).
8

9
Can be used by the following roles assigned at the organization scope:
10
- ORG_ADMIN
11

12
 */
13
export async function main(
14
  auth: Cockroachdb,
15
  id: string,
16
  body: { description?: string; name?: string },
17
) {
18
  const url = new URL(
19
    `https://cockroachlabs.cloud/api/v1/service-accounts/${id}`,
20
  );
21

22
  const response = await fetch(url, {
23
    method: "PATCH",
24
    headers: {
25
      "Content-Type": "application/json",
26
      Authorization: "Bearer " + auth.token,
27
    },
28
    body: JSON.stringify(body),
29
  });
30
  if (!response.ok) {
31
    const text = await response.text();
32
    throw new Error(`${response.status} ${text}`);
33
  }
34
  return await response.json();
35
}
36