Remove User Group Members
Remove users from a user group. Each removed user immediately loses every permission they held only through this group.
DELETE
Remove User Group Members
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Auth:UserGroups:Members:Remove: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Path Parameters
User group id.
Required string length:
1 - 64Pattern:
^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Body
application/json
Users to remove. Users not in the group are left unchanged.
Required array length:
1 - 100 elementsUser id.
Required string length:
1 - 64Pattern:
^us-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Response
200 - application/json
Success
The response is of type object.