Vinay Keshava 081c1a8e73 New upstream version 15.9.2+ds1

2023-04-23 21:23:45 +05:30

5.7 KiB

Raw Blame History

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/product/ux/technical-writing/#assignments

Project access tokens API (FREE)

You can read more about project access tokens.

List project access tokens

Introduced in GitLab 13.9.

Get a list of project access tokens.

GET projects/:id/access_tokens

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

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<project_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 project access token

Introduced in GitLab 14.10.

Get a project access token by ID.

GET projects/:id/access_tokens/:token_id

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

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<project_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,
   "last_used_at": "2022-03-15T11:05:42.437Z"
}

Create a project access token

Introduced in GitLab 13.10.

The token attribute was introduced in GitLab 13.10.

Create a project access token.

When you create a project access token, the maximum role (access level) you set depends on if you have the Owner or Maintainer role for the group. For example, the maximum role that can be set is:

Owner (50), if you have the Owner role for the project.
Maintainer (40), if you have the Maintainer role on the project.

In GitLab 14.8 and earlier, project access tokens have a maximum role of Maintainer.

POST projects/:id/access_tokens

Attribute	Type	required	Description
`id`	integer or string	yes	ID or URL-encoded path of the project
`name`	String	yes	Name of the project 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). Defaults to `40`.
`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/projects/<project_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 project access token