diff options
Diffstat (limited to 'doc/api/members.md')
| -rw-r--r-- | doc/api/members.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/api/members.md b/doc/api/members.md index bf2bf8c1220..286be10dd6e 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -237,6 +237,8 @@ Example response: Gets a list of group members that count as billable. The list includes members in the subgroup or subproject. +This API endpoint works on top-level groups only. It does not work on subgroups. + NOTE: Unlike other API endpoints, billable members is updated once per day at 12:00 UTC. @@ -308,6 +310,27 @@ Example response: ] ``` +## Remove a billable member from a group + +Removes a billable member from a group and its subgroups and projects. + +The user does not need to be a group member to qualify for removal. +For example, if the user was added directly to a project within the group, you can +still use this API to remove them. + +```plaintext +DELETE /groups/:id/billable_members/:user_id +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `user_id` | integer | yes | The user ID of the member | + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/billable_members/:user_id" +``` + ## Add a member to a group or project Adds a member to a group or project. |