Delete user group

Permanently deletes a user group and removes all associated permissions. This operation is irreversible.

Authorization: Requires group admin or organization modeler permissions. Warning: This operation will remove all group permissions and memberships. Side Effects: Removes group from all permission assignments.

DELETE /organizations/{organizationName}/groups/{groupName}

Delete user group

cURL

curl --request DELETE \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/groups/{groupName} \
  --header 'Authorization: Bearer <token>'

400

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName · string · required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$

groupName · string · required

The unique identifier of the group Group name pattern. Allows any character except / (would split the FGA resource path — see ResourceIdentifier.parseFromFga) and * (FGA wildcard). Length cap of 70 covers both user-defined groups (max 63 chars, enforced by Validators.isValidString) and workspace-derived groups (workspace name 1-63 + "-group" suffix).

Pattern: ^(?!.*\*)(?!.*[/]).{1,70}$

Response

200

Group deleted successfully