API Reference

Delete Group

DELETE/api/v2/admin/groups/{groupId}

Delete the Group with the specified id.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Path parameters

groupId

string

The ID of a Foundry Group or User.

Copied!

curl -X DELETE \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de"

Error Name
`DeleteGroupPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not delete the Group.
	Parameters	`groupId`

See Errors for a general overview of errors in the platform.