Delete

Signals the deletion of an entity.

Authorization

Implementations must ensure that the author of the Delete entity has the authorization to delete the target entity.

Having the authorization is defined as:

  • The author is the creator of the target entity (including delegation).
  • The author is the instance.

Entity Definition

  • Name
    author
    Required
    Required
    Type
    Reference
    Description

    Reference to the User who is deleting the entity.

  • Name
    deleted_type
    Required
    Required
    Type
    string
    Description

    Type of the entity being deleted.

  • Name
    deleted
    Required
    Required
    Type
    Reference
    Description

    Reference to the entity being deleted.

Example Delete

{
    "type": "Delete",
    "created_at": "2021-01-01T00:00:00.000Z",
    "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
    "deleted_type": "Note",
    "deleted": "02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
}