Groups

Remove a member from a group

DELETE/groups/{group_id}/members/{id}
groups:writedelete_group_memberDestructiveIdempotent

Takes the user out of the group and returns 204, and takes away the classification the group gave them. It has no dry run. The last member from your organisations of a group with no lead cannot be removed, because the group would belong to no organisation: it returns 409 conflict. Callers need update rights on the group, as for PATCH /groups/{id}; otherwise 403 missing_permission. Emits group_member.deleted; no emails or notifications are sent. POST /groups/{group_id}/members undoes it.

Path parameters

  • group_idstring (uuid)Required#

    The group's id, a uuid. An unknown group, or one your organisations cannot see, returns 404.

  • idstring (uuid)Required#

    The member's user id.

Responses

204

The member was removed.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is missing_permission when the caller may not change the group, with the permissions that would allow it in details, or one of missing_scope, scope_disabled, org_disabled, ip_blocked, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/groups/{group_id}/members/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"