Remove a group member

DELETE/v1/directory/groups/{group_id}/members/{person_id}

Takes someone out of a group, and with it the group's roles and apps.

Permission: identity:RemoveUserFromGroup. Changes need a sign-in that used a second factor.

Path parameters

Parameter Type Description
person_id string The person's ID.
group_id string The group's ID.

Returns

204 No Content, with no body.

Errors

Besides the errors every call can return:

Status When
404 No such resource in your organization.
409 It would leave your organization with no administrator.

Example

curl -X DELETE https://<company>.yotta.bot/v1/directory/groups/3c5e8a90-1d2b-4e6f-8a7c-9b0d1e2f3a4b/members/8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10 \
  -H "Authorization: Bearer $YOTTABOT_TOKEN"

With yottactl

yottactl org groups remove-member 3c5e8a90-1d2b-4e6f-8a7c-9b0d1e2f3a4b 8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10