Skip to main content

PermissionSet

@iota/audit-trails API documentation

Class: PermissionSet

Set of permissions granted by a role.

Constructors​

Constructor​

new PermissionSet(permissions): PermissionSet

Creates a permission set from an explicit list of permissions.

Parameters​

permissions​

any[]

Permissions to include in the set.

Returns​

PermissionSet

Properties​

permissions​

permissions: any[]

Permissions granted by this set.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string

adminPermissions()​

static adminPermissions(): PermissionSet

Returns the recommended permission set for the reserved initial-admin role.

Returns​

PermissionSet

A PermissionSet that authorizes role and capability administration.

Remarks​

Includes the following permissions:

capAdminPermissions()​

static capAdminPermissions(): PermissionSet

Returns the permissions needed to issue and revoke capabilities.

Returns​

PermissionSet

A PermissionSet that authorizes the capability lifecycle.

Remarks​

Includes the following permissions:

lockingAdminPermissions()​

static lockingAdminPermissions(): PermissionSet

Returns the permissions needed to administer locking rules.

Returns​

PermissionSet

A PermissionSet that authorizes updates to all locking dimensions.

Remarks​

Includes the following permissions:

metadataAdminPermissions()​

static metadataAdminPermissions(): PermissionSet

Returns the permissions needed to administer mutable metadata.

Returns​

PermissionSet

A PermissionSet that authorizes updating and clearing updatableMetadata.

Remarks​

Includes the following permissions:

recordAdminPermissions()​

static recordAdminPermissions(): PermissionSet

Returns the permissions needed to administer records.

Returns​

PermissionSet

A PermissionSet that authorizes record reads, writes, and deletions.

Remarks​

Includes the following permissions:

roleAdminPermissions()​

static roleAdminPermissions(): PermissionSet

Returns the permissions needed to administer roles.

Returns​

PermissionSet

A PermissionSet that authorizes adding, updating, and deleting roles.

Remarks​

Includes the following permissions:

tagAdminPermissions()​

static tagAdminPermissions(): PermissionSet

Returns the permissions needed to administer record tags.

Returns​

PermissionSet

A PermissionSet that authorizes adding and removing entries from the trail's record-tag registry.

Remarks​

Includes the following permissions: