File: keys.rst

package info (click to toggle)
python-gitlab 1%3A4.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,048 kB
  • sloc: python: 24,168; makefile: 171; ruby: 27; javascript: 3
file content (28 lines) | stat: -rw-r--r-- 490 bytes parent folder | download | duplicates (2) 
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
 
####
Keys
####

Keys
====

Reference
---------

* v4 API

  + :class:`gitlab.v4.objects.Key`
  + :class:`gitlab.v4.objects.KeyManager`
  + :attr:`gitlab.Gitlab.keys`

* GitLab API: https://docs.gitlab.com/ce/api/keys.html

Examples
--------

Get an ssh key by its id (requires admin access)::

    key = gl.keys.get(key_id)

Get an ssh key (requires admin access) or a deploy key by its fingerprint::

    key = gl.keys.get(fingerprint="SHA256:ERJJ/OweAM6jA8OjJ/gXs4N5fqUaREEJnz/EyfywfXY")