Search documentation
karat

+

K

User Documentation ↗
Version 2.0

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

A Foundry Group ID.

Examples

Request

Copied!
1 2 3 curl -X DELETE \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b"

Error responses

Error Name
DeleteGroupPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the Group.
ParametersgroupId
DeleteGroupPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the Group.
ParametersgroupId
GroupNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Group could not be found.
ParametersgroupId