File: project_access_tokens.rst

package info (click to toggle)
python-gitlab 1%3A8.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,884 kB
  • sloc: python: 25,823; makefile: 171; ruby: 27; javascript: 3
file content (54 lines) | stat: -rw-r--r-- 1,390 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#####################
Project Access Tokens
#####################

Get a list of project access tokens

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectAccessToken`
  + :class:`gitlab.v4.objects.ProjectAccessTokenManager`
  + :attr:`gitlab.Gitlab.project_access_tokens`

* GitLab API: https://docs.gitlab.com/api/project_access_tokens

Examples
--------

List project access tokens::

    access_tokens = gl.projects.get(1, lazy=True).access_tokens.list(get_all=True)
    print(access_tokens[0].name)

Get a project access token by id::

    token = project.access_tokens.get(123)
    print(token.name)

Create project access token::

    access_token = gl.projects.get(1).access_tokens.create({"name": "test", "scopes": ["api"], "expires_at": "2023-06-06"})

Revoke a project access token::

    gl.projects.get(1).access_tokens.delete(42)
    # or
    access_token.delete()

Rotate a project access token and retrieve its new value::

    token = project.access_tokens.get(42, lazy=True)
    token.rotate()
    print(token.token)
    # or directly using a token ID
    new_token = project.access_tokens.rotate(42)
    print(new_token.token)

Self-Rotate the project access token you are using to authenticate the request and retrieve its new value::

    token = project.access_tokens.get(42, lazy=True)
    token.rotate(self_rotate=True)
    print(new_token.token)