• List group access tokens
• Get a group access token
• Create a group access token
• Rotate a group access token
  • Responses
  • Automatic reuse detection
• Revoke a group access token
  • Responses

Group access tokens API

You can read more about group access tokens.

List group access tokens

Get a list of group access tokens.

GET groups/:id/access_tokens

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/<group_id>/access_tokens"

[
   {
      "user_id" : 141,
      "scopes" : [
         "api"
      ],
      "name" : "token",
      "expires_at" : "2021-01-31",
      "id" : 42,
      "active" : true,
      "created_at" : "2021-01-20T22:11:48.151Z",
      "revoked" : false,
      "access_level": 40
   }
]

Get a group access token

Get a group access token by ID.

GET groups/:id/access_tokens/:token_id

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/<group_id>/access_tokens/<token_id>"

{
   "user_id" : 141,
   "scopes" : [
      "api"
   ],
   "name" : "token",
   "expires_at" : "2021-01-31",
   "id" : 42,
   "active" : true,
   "created_at" : "2021-01-20T22:11:48.151Z",
   "revoked" : false,
   "access_level": 40
}

Create a group access token

Create a group access token. You must have the Owner role for the group to create group access tokens.

POST groups/:id/access_tokens

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type:application/json" \
--data '{ "name":"test_token", "scopes":["api", "read_repository"], "expires_at":"2021-01-31", "access_level": 30 }' \
"https://gitlab.example.com/api/v4/groups/<group_id>/access_tokens"

{
   "scopes" : [
      "api",
      "read_repository"
   ],
   "active" : true,
   "name" : "test",
   "revoked" : false,
   "created_at" : "2021-01-21T19:35:37.921Z",
   "user_id" : 166,
   "id" : 58,
   "expires_at" : "2021-01-31",
   "token" : "D4y...Wzr",
   "access_level": 30
}

Rotate a group access token

Rotate a group access token. Revokes the previous token and creates a new token that expires in one week.

In GitLab 16.6 and later, you can use the expires_at parameter to set a different expiry date. This non-default expiry date can be up to a maximum of one year from the rotation date.

POST /groups/:id/access_tokens/:token_id/rotate

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/<group_id>/access_tokens/<token_id>/rotate"

Example response:

{
    "id": 42,
    "name": "Rotated Token",
    "revoked": false,
    "created_at": "2023-08-01T15:00:00.000Z",
    "scopes": ["api"],
    "user_id": 1337,
    "last_used_at": null,
    "active": true,
    "expires_at": "2023-08-15",
    "access_level": 30,
    "token": "s3cr3t"
}

Responses

• 200: OK if existing token is successfully revoked and the new token is created.
• 400: Bad Request if not rotated successfully.
• 401: Unauthorized if either the:
  • User does not have access to the token with the specified ID.
  • Token with the specified ID does not exist.
• 404: Not Found if the user is an administrator but the token with the specified ID does not exist.

Automatic reuse detection

Refer to automatic reuse detection for personal access tokens for more information.

Revoke a group access token

Revoke a group access token.

DELETE groups/:id/access_tokens/:token_id

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/<group_id>/access_tokens/<token_id>"

Responses

• 204: No Content if successfully revoked.
• 400 Bad Request or 404 Not Found if not revoked successfully.