gitlab-org--gitlab-foss/doc/api/group_access_tokens.md

stage	group	info
Manage	Authentication and Authorization	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Group access tokens API (FREE)

You can read more about group access tokens.

List group access tokens

Introduced in GitLab 14.7.

Get a list of group access tokens.

GET groups/:id/access_tokens

Attribute	Type	required	Description
id	integer or string	yes	ID or URL-encoded path of the group

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

Introduced in GitLab 14.10.

Get a group access token by ID.

GET groups/:id/access_tokens/:token_id

Attribute	Type	required	Description
id	integer or string	yes	ID or URL-encoded path of the group
token_id	integer or string	yes	ID of the group access token

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

Introduced in GitLab 14.7.

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

POST groups/:id/access_tokens

Attribute	Type	required	Description
id	integer or string	yes	ID or URL-encoded path of the group
name	String	yes	Name of the group access token
scopes	Array[String]	yes	List of scopes
access_level	Integer	no	Access level. Valid values are 10 (Guest), 20 (Reporter), 30 (Developer), 40 (Maintainer), and 50 (Owner).
expires_at	Date	no	Token expires at midnight UTC on that date

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
}

Revoke a group access token

Introduced in GitLab 14.7.

Revoke a group access token.

DELETE groups/:id/access_tokens/:token_id

Attribute	Type	required	Description
id	integer or string	yes	ID or URL-encoded path of the group
token_id	integer or string	yes	ID of the group access token

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.