Skip to main content

RoleMap

@iota/audit-trails API documentation

Class: RoleMap

Snapshot of the trail's role map.

Remarks​

Mirrors the access-control state maintained by the audit-trail package, including the reserved initial-admin role, the revoked-capability denylist, and the role data used for tag-aware authorization.

Properties​

capabilityAdminPermissions​

capabilityAdminPermissions: CapabilityAdminPermissions

Permissions required to administer capabilities.

initialAdminCapIds​

initialAdminCapIds: string[]

Capability IDs currently recognized as initial-admin capabilities.

initialAdminRoleName​

initialAdminRoleName: string

Reserved role name used for initial-admin capabilities.

Always equals "Admin". The role bearing this name cannot be deleted.

revokedCapabilities​

revokedCapabilities: ObjectIdLinkedTable

Denylist of revoked capability IDs.

roleAdminPermissions​

roleAdminPermissions: RoleAdminPermissions

Permissions required to administer roles.

roles​

roles: RolePermissionsEntry[]

Role definitions sorted by role name.

targetKey​

targetKey: string

Trail object ID that this role map protects.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string