GitLabgitlab-org

cli

main
ply7 git calls290 ms98 KiB5 cachedprotocol v2
63 lines2.6 KiBRaw

Update a service account.

Synopsis

Update the name, username, or email address of a service account of a project or a group, by its ID or username.

  • Only the given fields change. At least one of --name, --username, or --email is required.
  • A field cannot be cleared, so an empty value is rejected.
  • A numeric argument is always treated as an ID. IDs and usernames come from glab service-account list.
  • A new custom email address must be confirmed before the account uses it, unless the top-level group has a matching verified domain or email confirmation is turned off on the instance. Until then, the address is shown as the unconfirmed email.
  • The username of a service account associated with a composite identity cannot be changed.

Updating a group service account requires GitLab 17.10 or later. Changing the email address requires GitLab 18.2 or later.

plaintext
glab service-account update <id | username> [flags]

Examples

console
# Rename service account 42 of the current project
glab service-account update 42 --name "Release bot"

# Change the username of a service account, found by its current username
glab service-account update release-bot --username release-bot-2

# Change the email address of a service account of a specific project
glab service-account update 42 --email release-bot@example.com --repo user/my-repo

# Rename a group's service account
glab service-account update 42 --name "Release bot" --group my-group

Options

plaintext
      --email string        New email address of the service account.
  -g, --group group         Update a service account of a group instead of a project. Accepts a group ID or full path.
      --jq string           Filter JSON output with a jq expression.
      --name string         New name of the service account.
  -F, --output string       Format output as: text, json. (default "text")
  -R, --repo string         Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
      --username username   New username of the service account.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab service-account update`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Update a service account.
15## Synopsis
17Update the name, username, or email address of a service account of a project or a group, by its ID or username.
19- Only the given fields change. At least one of `--name`, `--username`, or `--email` is required.
20- A field cannot be cleared, so an empty value is rejected.
21- A numeric argument is always treated as an ID. IDs and usernames come from `glab service-account list`.
22- A new custom email address must be confirmed before the account uses it, unless the top-level group has a matching verified domain or email confirmation is turned off on the instance. Until then, the address is shown as the unconfirmed email.
23- The username of a service account associated with a composite identity cannot be changed.
25Updating a group service account requires GitLab 17.10 or later. Changing the email address requires GitLab 18.2 or later.
27```plaintext
28glab service-account update <id | username> [flags]
29```
31## Examples
33```console
34# Rename service account 42 of the current project
35glab service-account update 42 --name "Release bot"
37# Change the username of a service account, found by its current username
38glab service-account update release-bot --username release-bot-2
40# Change the email address of a service account of a specific project
41glab service-account update 42 --email release-bot@example.com --repo user/my-repo
43# Rename a group's service account
44glab service-account update 42 --name "Release bot" --group my-group
45```
47## Options
49```plaintext
50 --email string New email address of the service account.
51 -g, --group group Update a service account of a group instead of a project. Accepts a group ID or full path.
52 --jq string Filter JSON output with a jq expression.
53 --name string New name of the service account.
54 -F, --output string Format output as: text, json. (default "text")
55 -R, --repo string Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
56 --username username New username of the service account.
57```
59## Options inherited from parent commands
61```plaintext
62 -h, --help Show help for this command.
63```
Diagnostics7 git calls · 290 ms
CallStatusSizeTime0290 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit8 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=8
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=8
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:02001.7 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200285 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=285
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=798e9cb0460576913a41f828cc28d38c8507c49e
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=285
git.pkt.payload.max=258
git.sideband.band1.bytes=258
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=258
git.pack.trailer=704ba44418421108143e6ecdb3e079a03125325b
Open pack map
fetch2001.2 KiB275 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=275
git.response.bytes=1198
git.response.cache=MISS
git.response.duration_ms=275
git.fetch.wants=40fd25351efaf9b469132614811f7006d41abdbd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1198
git.pkt.payload.max=1171
git.sideband.band1.bytes=1171
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e16f2fdd936102
Request
146ac882…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format