Delete a group.

Only a group manager or a user with administrator role can delete a group. A group cannot be deleted as long as it is the sole owner of a shared resource or folder.

delete/groups/{groupId}.json

Request

Base URL
https://passbolt.local
Auth
HTTP bearer
TypeScript
https://skmtc.dev/passbolt/apis/passbolt-api/docs/groups/:groupId.json/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

groupIdstring uuid required

ID for the group being manipulated.

Response

Operation is successful.

bodyunknown required

Example response

{
  "header": {
    "servertime": 1720702619,
    "message": "The operation was successful.",
    "url": "/auth/verify.json",
    "code": 200
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.