Skip to main content

deleteGroupMember

Remove a member from a group.

The member immediately loses any access granted by this group. If this was their only group in the organization, they lose all access to the organization. Requires the organization:manageGroups action.

deleteGroupMember(
organizationId: ID!
groupId: UUID!
email: String!
): DeletedGroupMemberPayload

Arguments​

deleteGroupMember.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

deleteGroupMember.groupId ● UUID! non-null scalar {#group-id}​

The group to remove the member from.

deleteGroupMember.email ● String! non-null scalar {#email}​

Email address of the member to remove.

Type​

DeletedGroupMemberPayload object​