diff options
Diffstat (limited to 'doc/api/members.md')
| -rw-r--r-- | doc/api/members.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/api/members.md b/doc/api/members.md index 0b8cf686b8c..44e58f49d3b 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -336,7 +336,7 @@ The response represents only direct memberships. Inherited memberships are not i This API endpoint works on top-level groups only. It does not work on subgroups. -This API endpoint requires permission to admin memberships for the group. +This API endpoint requires permission to administer memberships for the group. This API endpoint takes [pagination](index.md#pagination) parameters `page` and `per_page` to restrict the list of memberships. @@ -561,7 +561,12 @@ Example response: ## Remove a member from a group or project -Removes a user from a group or project. +Removes a user from a group or project where the user has been explicitly assigned a role. + +The user needs to be a group member to qualify for removal. +For example, if the user was added directly to a project within the group but not this +group explicitly, you cannot use this API to remove them. See +[Remove a billable member from a group](#remove-a-billable-member-from-a-group) for an alternative approach. ```plaintext DELETE /groups/:id/members/:user_id |