Repository navigation
Commit 065a1a5
committed
docs(users): add docs about listing a user's projects
Add docs about listing a user's projects.
Update docs on the membership API to update the URL to the upstream
docs and also add a note that it requires Administrator access to use.1 parent d15fea0 commit 065a1a5
1 file changed
Lines changed: 30 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -192,6 +192,31 @@ Revoke (delete) an impersonation token for a user:: | |||
| 192 | 192 | i_t.delete() | |
| 193 | 193 | ||
| 194 | 194 | ||
| 195 | + User projects | ||
| 196 | + ========================= | ||
| 197 | + | ||
| 198 | + References | ||
| 199 | + ---------- | ||
| 200 | + | ||
| 201 | + * v4 API: | ||
| 202 | + | ||
| 203 | + + :class:`gitlab.v4.objects.UserProject` | ||
| 204 | + + :class:`gitlab.v4.objects.UserProjectManager` | ||
| 205 | + + :attr:`gitlab.v4.objects.User.projects` | ||
| 206 | + | ||
| 207 | + * GitLab API: https://docs.gitlab.com/ee/api/projects.html#list-user-projects | ||
| 208 | + | ||
| 209 | + List visible projects in the user's namespace:: | ||
| 210 | + | ||
| 211 | + projects = user.projects.list() | ||
| 212 | + | ||
| 213 | + .. note:: | ||
| 214 | + | ||
| 215 | + Only the projects in the user’s namespace are returned. Projects owned by | ||
| 216 | + the user in any group or subgroups are not returned. An empty list is | ||
| 217 | + returned if a profile is set to private. | ||
| 218 | + | ||
| 219 | + | ||
| 195 | 220 | User memberships | |
| 196 | 221 | ========================= | |
| 197 | 222 | ||
@@ -204,7 +229,7 @@ References | |||
| 204 | 229 | + :class:`gitlab.v4.objects.UserMembershipManager` | |
| 205 | 230 | + :attr:`gitlab.v4.objects.User.memberships` | |
| 206 | 231 | ||
| 207 | - * GitLab API: https://docs.gitlab.com/ee/api/users.html#user-memberships-admin-only | ||
| 232 | + * GitLab API: https://docs.gitlab.com/ee/api/users.html#user-memberships | ||
| 208 | 233 | ||
| 209 | 234 | List direct memberships for a user:: | |
| 210 | 235 | ||
@@ -218,6 +243,10 @@ List only direct group memberships:: | |||
| 218 | 243 | ||
| 219 | 244 | memberships = user.memberships.list(type='Namespace') | |
| 220 | 245 | ||
| 246 | + .. note:: | ||
| 247 | + | ||
| 248 | + This endpoint requires admin access. | ||
| 249 | + | ||
| 221 | 250 | Current User | |
| 222 | 251 | ============ | |
| 223 | 252 | ||
0 commit comments