Skip to main content

Permission

@iota/audit-trails API documentation


Enumeration: Permission

Permission variants enumerated by Audit Trails.

Remarks

Each variant authorizes one operation on a trail. Variants are grouped by the proposed role that typically owns them (Admin, RecordAdmin, LockingAdmin, RoleAdmin, CapAdmin, MetadataAdmin, TagAdmin); see PermissionSet for the recommended sets.

Enumeration Members

DeleteAuditTrail

DeleteAuditTrail: 0

Authorizes deleting the trail itself.


DeleteAllRecords

DeleteAllRecords: 1

Authorizes the batched record-deletion entry point.


AddRecord

AddRecord: 2

Authorizes appending a record.


DeleteRecord

DeleteRecord: 3

Authorizes deleting an individual record.


CorrectRecord

CorrectRecord: 4

Authorizes adding a record that supersedes earlier records via RecordCorrection.


UpdateLockingConfig

UpdateLockingConfig: 5

Authorizes replacing the full LockingConfig.


UpdateLockingConfigForDeleteRecord

UpdateLockingConfigForDeleteRecord: 6

Authorizes updating only the delete-record window of the locking configuration.


UpdateLockingConfigForDeleteTrail

UpdateLockingConfigForDeleteTrail: 7

Authorizes updating only the delete-trail lock of the locking configuration.


UpdateLockingConfigForWrite

UpdateLockingConfigForWrite: 8

Authorizes updating only the write lock of the locking configuration.


AddRoles

AddRoles: 9

Authorizes creating roles.


UpdateRoles

UpdateRoles: 10

Authorizes updating existing roles.


DeleteRoles

DeleteRoles: 11

Authorizes deleting roles.


AddCapabilities

AddCapabilities: 12

Authorizes issuing capabilities.


RevokeCapabilities

RevokeCapabilities: 13

Authorizes revoking, destroying, and cleaning up capabilities.


UpdateMetadata

UpdateMetadata: 14

Authorizes replacing the trail's updatableMetadata.


DeleteMetadata

DeleteMetadata: 15

Authorizes clearing the trail's updatableMetadata.


Migrate

Migrate: 16

Authorizes the migration entry point used after package upgrades.


AddRecordTags

AddRecordTags: 17

Authorizes adding entries to the trail's record-tag registry.


DeleteRecordTags

DeleteRecordTags: 18

Authorizes removing entries from the trail's record-tag registry.