Skip to main content

deleteGroup

Delete a group.

Only groups with the CUSTOM role can be deleted. The built-in organization_admin and organization_viewer groups are permanent and cannot be removed. All members lose the access granted by this group immediately upon deletion. Requires organization_admin permissions.

deleteGroup(
organizationId: ID!
id: ID!
): GroupPayload

Arguments

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

Your organization's unique identifier.

deleteGroup.id ● ID! non-null scalar {#id}

The group's unique identifier.

Type

GroupPayload object