Module: Gitlab::Client::Groups
- Included in:
- Gitlab::Client
- Defined in:
- lib/gitlab/client/groups.rb
Overview
Defines methods related to groups.
Instance Method Summary collapse
-
#add_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to group.
-
#add_ldap_group_links(id, commonname, group_access, provider) ⇒ Gitlab::ObjectifiedHash
Add LDAP group link.
-
#create_group(name, path, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new group.
-
#delete_group(id) ⇒ Gitlab::ObjectifiedHash
Delete’s a group.
-
#delete_ldap_group_links(id, commonname, provider) ⇒ Gitlab::ObjectifiedHash
Delete LDAP group link.
-
#edit_group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing group.
-
#edit_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Edit a user of a group.
-
#group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Gets a single group.
-
#group_issues(group, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of issues of a group.
-
#group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Get details of a single group member.
-
#group_members(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of group members.
-
#group_merge_requests(group, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of merge requests of a group.
-
#group_projects(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of projects under a group.
-
#group_search(search, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for groups by name.
-
#group_subgroups(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of subgroups under a group.
-
#groups(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of groups.
-
#remove_group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Removes user from user group.
-
#sync_ldap_group(id) ⇒ Array<Gitlab::ObjectifiedHash>
Sync group with LDAP.
-
#transfer_project_to_group(id, project_id) ⇒ Object
Transfers a project to a group.
Instance Method Details
#add_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to group.
107 108 109 |
# File 'lib/gitlab/client/groups.rb', line 107 def add_group_member(team_id, user_id, access_level) post("/groups/#{url_encode team_id}/members", body: { user_id: user_id, access_level: access_level }) end |
#add_ldap_group_links(id, commonname, group_access, provider) ⇒ Gitlab::ObjectifiedHash
Add LDAP group link
243 244 245 |
# File 'lib/gitlab/client/groups.rb', line 243 def add_ldap_group_links(id, commonname, group_access, provider) post("/groups/#{url_encode id}/ldap_group_links", body: { cn: commonname, group_access: group_access, provider: provider }) end |
#create_group(name, path, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new group.
44 45 46 47 |
# File 'lib/gitlab/client/groups.rb', line 44 def create_group(name, path, = {}) body = { name: name, path: path }.merge() post('/groups', body: body) end |
#delete_group(id) ⇒ Gitlab::ObjectifiedHash
Delete’s a group.
55 56 57 |
# File 'lib/gitlab/client/groups.rb', line 55 def delete_group(id) delete("/groups/#{url_encode id}") end |
#delete_ldap_group_links(id, commonname, provider) ⇒ Gitlab::ObjectifiedHash
Delete LDAP group link
255 256 257 |
# File 'lib/gitlab/client/groups.rb', line 255 def delete_ldap_group_links(id, commonname, provider) delete("/groups/#{url_encode id}/ldap_group_links/#{url_encode provider}/#{url_encode commonname}") end |
#edit_group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing group.
206 207 208 |
# File 'lib/gitlab/client/groups.rb', line 206 def edit_group(id, = {}) put("/groups/#{url_encode id}", body: ) end |
#edit_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Edit a user of a group.
120 121 122 |
# File 'lib/gitlab/client/groups.rb', line 120 def edit_group_member(team_id, user_id, access_level) put("/groups/#{url_encode team_id}/members/#{user_id}", body: { access_level: access_level }) end |
#group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Gets a single group.
31 32 33 |
# File 'lib/gitlab/client/groups.rb', line 31 def group(id, = {}) get("/groups/#{url_encode id}", query: ) end |
#group_issues(group, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of issues of a group.
218 219 220 |
# File 'lib/gitlab/client/groups.rb', line 218 def group_issues(group, = {}) get("/groups/#{group}/issues", query: ) end |
#group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Get details of a single group member.
82 83 84 |
# File 'lib/gitlab/client/groups.rb', line 82 def group_member(team_id, user_id) get("/groups/#{url_encode team_id}/members/#{user_id}") end |
#group_members(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of group members.
70 71 72 |
# File 'lib/gitlab/client/groups.rb', line 70 def group_members(id, = {}) get("/groups/#{url_encode id}/members", query: ) end |
#group_merge_requests(group, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of merge requests of a group.
94 95 96 |
# File 'lib/gitlab/client/groups.rb', line 94 def group_merge_requests(group, = {}) get("/groups/#{group}/merge_requests", query: ) end |
#group_projects(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of projects under a group
169 170 171 |
# File 'lib/gitlab/client/groups.rb', line 169 def group_projects(id, = {}) get("/groups/#{url_encode id}/projects", query: ) end |
#group_search(search, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for groups by name
158 159 160 161 |
# File 'lib/gitlab/client/groups.rb', line 158 def group_search(search, = {}) [:search] = search get('/groups', query: ) end |
#group_subgroups(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of subgroups under a group
187 188 189 |
# File 'lib/gitlab/client/groups.rb', line 187 def group_subgroups(id, = {}) get("/groups/#{url_encode id}/subgroups", query: ) end |
#groups(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of groups.
17 18 19 |
# File 'lib/gitlab/client/groups.rb', line 17 def groups( = {}) get('/groups', query: ) end |
#remove_group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Removes user from user group.
132 133 134 |
# File 'lib/gitlab/client/groups.rb', line 132 def remove_group_member(team_id, user_id) delete("/groups/#{url_encode team_id}/members/#{user_id}") end |
#sync_ldap_group(id) ⇒ Array<Gitlab::ObjectifiedHash>
Sync group with LDAP
229 230 231 |
# File 'lib/gitlab/client/groups.rb', line 229 def sync_ldap_group(id) post("/groups/#{url_encode id}/ldap_sync") end |
#transfer_project_to_group(id, project_id) ⇒ Object
Transfers a project to a group
143 144 145 146 |
# File 'lib/gitlab/client/groups.rb', line 143 def transfer_project_to_group(id, project_id) body = { id: id, project_id: project_id } post("/groups/#{url_encode id}/projects/#{project_id}", body: body) end |