summaryrefslogtreecommitdiff
path: root/docs/gl_objects/keys.rst
blob: 6d35218096775a5c0c3ade1cd170b2a15155b707 (plain)
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")