3 KiB
3 KiB
stage | group | info |
---|---|---|
Manage | Access | 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 |
Project access tokens API
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/string | yes | The ID 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
}
]
Create a project access token
- Introduced in GitLab 13.9.
Create a project access token.
POST projects/:id/access_tokens
Attribute | Type | required | Description |
---|---|---|---|
name |
String | yes | The name of the project access token |
scopes |
Array[String] | yes | List of scopes |
expires_at |
Date | no | The 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" }' \
"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"
}
Revoke a project access token
- Introduced in GitLab 13.9.
Revoke a project access token.
DELETE projects/:id/access_tokens/:token_id
Attribute | Type | required | Description |
---|---|---|---|
id |
integer/string | yes | The ID of the project |
token_id |
integer/string | yes | The ID of the project access token |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<project_id>/access_tokens/<token_id>"
Responses
204: No Content
if successfully revoked.400 Bad Request
or404 Not Found
if not revoked successfully.