blob: 8df93b03f1791223a049777a1907815c9f371239 (
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
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
#####
Users
#####
Use :class:`~gitlab.objects.User` objects to manipulate repository branches.
To create :class:`~gitlab.objects.User` objects use the
:attr:`gitlab.Gitlab.users` manager.
Examples
========
Get the list of users:
.. literalinclude:: users.py
:start-after: # list
:end-before: # end list
Search users whose username match the given string:
.. literalinclude:: users.py
:start-after: # search
:end-before: # end search
Get a single user:
.. literalinclude:: users.py
:start-after: # get
:end-before: # end get
Create a user:
.. literalinclude:: users.py
:start-after: # create
:end-before: # end create
Update a user:
.. literalinclude:: users.py
:start-after: # update
:end-before: # end update
Delete a user:
.. literalinclude:: users.py
:start-after: # delete
:end-before: # end delete
Block/Unblock a user:
.. literalinclude:: users.py
:start-after: # block
:end-before: # end block
SSH keys
========
Use the :class:`~gitlab.objects.UserKey` objects to manage user keys.
To create :class:`~gitlab.objects.UserKey` objects use the
:attr:`User.keys <gitlab.objects.User.keys>` or :attr:`gitlab.Gitlab.user_keys`
managers.
Exemples
--------
List SSH keys for a user:
.. literalinclude:: users.py
:start-after: # key list
:end-before: # end key list
Get an SSH key for a user:
.. literalinclude:: users.py
:start-after: # key get
:end-before: # end key get
Create an SSH key for a user:
.. literalinclude:: users.py
:start-after: # key create
:end-before: # end key create
Delete an SSH key for a user:
.. literalinclude:: users.py
:start-after: # key delete
:end-before: # end key delete
Emails
======
Use the :class:`~gitlab.objects.UserEmail` objects to manage user emails.
To create :class:`~gitlab.objects.UserEmail` objects use the :attr:`User.emails
<gitlab.objects.User.emails>` or :attr:`gitlab.Gitlab.user_emails` managers.
Exemples
--------
List emails for a user:
.. literalinclude:: users.py
:start-after: # email list
:end-before: # end email list
Get an email for a user:
.. literalinclude:: users.py
:start-after: # email get
:end-before: # end email get
Create an email for a user:
.. literalinclude:: users.py
:start-after: # email create
:end-before: # end email create
Delete an email for a user:
.. literalinclude:: users.py
:start-after: # email delete
:end-before: # end email delete
Current User
============
Use the :class:`~gitlab.objects.CurrentUser` object to get information about
the currently logged-in user.
Use the :class:`~gitlab.objects.CurrentUserKey` objects to manage user keys.
To create :class:`~gitlab.objects.CurrentUserKey` objects use the
:attr:`gitlab.objects.CurrentUser.keys <CurrentUser.keys>` manager.
Use the :class:`~gitlab.objects.CurrentUserEmail` objects to manage user emails.
To create :class:`~gitlab.objects.CurrentUserEmail` objects use the
:attr:`gitlab.objects.CurrentUser.emails <CurrentUser.emails>` manager.
Examples
--------
Get the current user:
.. literalinclude:: users.py
:start-after: # currentuser get
:end-before: # end currentuser get
List the current user SSH keys:
.. literalinclude:: users.py
:start-after: # currentuser key list
:end-before: # end currentuser key list
Get a key for the current user:
.. literalinclude:: users.py
:start-after: # currentuser key get
:end-before: # end currentuser key get
Create a key for the current user:
.. literalinclude:: users.py
:start-after: # currentuser key create
:end-before: # end currentuser key create
Delete a key for the current user:
.. literalinclude:: users.py
:start-after: # currentuser key delete
:end-before: # end currentuser key delete
List the current user emails:
.. literalinclude:: users.py
:start-after: # currentuser email list
:end-before: # end currentuser email list
Get an email for the current user:
.. literalinclude:: users.py
:start-after: # currentuser email get
:end-before: # end currentuser email get
Create an email for the current user:
.. literalinclude:: users.py
:start-after: # currentuser email create
:end-before: # end currentuser email create
Delete an email for the current user:
.. literalinclude:: users.py
:start-after: # currentuser email delete
:end-before: # end currentuser email delete
|
