GitLabgitlab-org

cli

main
ply8 git calls219 ms99 KiB5 cachedprotocol v2
62 lines2.8 KiBRaw

Rotate a token of a service account.

Synopsis

Rotate a personal access token of a service account of a project or a group.

  • Rotating revokes the token and creates a new one with the same name, description, and scopes. Anything using the old value stops working immediately.
  • The new token value is printed only once and cannot be retrieved later. It is the only output on stdout, and the token details go to stderr.
  • The new token expires after --duration, 30 days by default, at 00:00 UTC. Use --expires-at for a specific date instead.
  • A token name matches active tokens only. If several active tokens share the name, use the token ID instead.
  • Numeric arguments are always treated as IDs. Token IDs and names come from glab service-account token list.

Finding a token by name for a group service account requires GitLab 17.11 or later.

plaintext
glab service-account token rotate <account-id | username> <token-id | name> [flags]

Examples

console
# Rotate token 7 of service account 42 of the current project
glab service-account token rotate 42 7

# Rotate a token by its name for 90 days, finding the account by its username
glab service-account token rotate release-bot ci --duration 90d

# Rotate a token of a group's service account until the end of 2027
glab service-account token rotate 42 7 --expires-at 2027-12-31 --group my-group

# Rotate a token and store the new value in a variable
TOKEN=$(glab service-account token rotate 42 ci)

Options

plaintext
  -D, --duration duration   Sets the token lifetime in days. Accepts: days (30d), weeks (4w), or hours in multiples of 24 (24h, 168h, 720h). Maximum: 365d. The token expires at midnight UTC on the calculated date. (default 30d)
  -E, --expires-at time     Expiry date of the new token, as YYYY-MM-DD. The token expires at midnight UTC on that date.
  -g, --group group         Rotate a token of 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.
  -F, --output string       Format output as 'text' for the token value, 'json' for the token with its details. (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.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab service-account token rotate`'
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-->
13Rotate a token of a service account.
15## Synopsis
17Rotate a personal access token of a service account of a project or a group.
19- Rotating revokes the token and creates a new one with the same name, description, and scopes. Anything using the old value stops working immediately.
20- The new token value is printed only once and cannot be retrieved later. It is the only output on stdout, and the token details go to stderr.
21- The new token expires after `--duration`, 30 days by default, at 00:00 UTC. Use `--expires-at` for a specific date instead.
22- A token name matches active tokens only. If several active tokens share the name, use the token ID instead.
23- Numeric arguments are always treated as IDs. Token IDs and names come from `glab service-account token list`.
25Finding a token by name for a group service account requires GitLab 17.11 or later.
27```plaintext
28glab service-account token rotate <account-id | username> <token-id | name> [flags]
29```
31## Examples
33```console
34# Rotate token 7 of service account 42 of the current project
35glab service-account token rotate 42 7
37# Rotate a token by its name for 90 days, finding the account by its username
38glab service-account token rotate release-bot ci --duration 90d
40# Rotate a token of a group's service account until the end of 2027
41glab service-account token rotate 42 7 --expires-at 2027-12-31 --group my-group
43# Rotate a token and store the new value in a variable
44TOKEN=$(glab service-account token rotate 42 ci)
45```
47## Options
49```plaintext
50 -D, --duration duration Sets the token lifetime in days. Accepts: days (30d), weeks (4w), or hours in multiples of 24 (24h, 168h, 720h). Maximum: 365d. The token expires at midnight UTC on the calculated date. (default 30d)
51 -E, --expires-at time Expiry date of the new token, as YYYY-MM-DD. The token expires at midnight UTC on that date.
52 -g, --group group Rotate a token of a service account of a group instead of a project. Accepts a group ID or full path.
53 --jq string Filter JSON output with a jq expression.
54 -F, --output string Format output as 'text' for the token value, 'json' for the token with its details. (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```
58## Options inherited from parent commands
60```plaintext
61 -h, --help Show help for this command.
62```
Diagnostics8 git calls · 219 ms
CallStatusSizeTime0219 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
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 KiB2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=2
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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=285
git.response.cache=HIT
git.response.duration_ms=3
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
fetchtree:0200224 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=224
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=30e8f8c80438a64468269dab5872c3a78c2fa0c2
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=224
git.pkt.payload.max=197
git.sideband.band1.bytes=197
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=197
git.pack.trailer=c8de78f759866fd7cfd8d57b5ba2b49d203dbbc5
Open pack map
fetch2001.4 KiB208 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=208
git.response.bytes=1385
git.response.cache=MISS
git.response.duration_ms=208
git.fetch.wants=e8096deb445d4e2b71d8182298d6e665ae7d5366
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=1385
git.pkt.payload.max=1358
git.sideband.band1.bytes=1358
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
a5e2c8f1f9554b67
Request
2f321767…
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