Skip to main content
Version: 24.7.x

Class: Permissions

api/entities/Asset/Base/Permissions.Permissions

Handles all Asset Permissions related functionality

Hierarchy

Methods

createGroup

createGroup(args, opts?): Promise<GenericPolymeshTransaction<CustomPermissionGroup, CustomPermissionGroup>>

Create a Permission Group for this Asset. Identities can be assigned to Permission Groups as agents. Agents assigned to a Permission Group have said group's permissions over the Asset

Parameters

NameType
argsCreateGroupParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<CustomPermissionGroup, CustomPermissionGroup>>

Note

this method is of type ProcedureMethod, which means you can call createGroup.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Asset/Base/Permissions/index.ts:69


getAgents

getAgents(): Promise<AgentWithGroup[]>

Retrieve a list of agents (Identities which have permissions over the Asset) and their respective Permission Groups

Returns

Promise<AgentWithGroup[]>

Defined in

api/entities/Asset/Base/Permissions/index.ts:170


getGroup

getGroup(args): Promise<CustomPermissionGroup>

Retrieve a single Permission Group by its ID (or type). Passing an ID will fetch a Custom Permission Group, while passing a type will fetch a Known Permission Group

Parameters

NameType
argsObject
args.idBigNumber

Returns

Promise<CustomPermissionGroup>

Throws

if there is no Permission Group with the passed ID

Defined in

api/entities/Asset/Base/Permissions/index.ts:103

getGroup(args): Promise<KnownPermissionGroup>

Parameters

NameType
argsObject
args.typePermissionGroupType

Returns

Promise<KnownPermissionGroup>

Defined in

api/entities/Asset/Base/Permissions/index.ts:104


getGroups

getGroups(): Promise<PermissionGroups>

Retrieve all Permission Groups of this Asset

Returns

Promise<PermissionGroups>

Defined in

api/entities/Asset/Base/Permissions/index.ts:136


inviteAgent

inviteAgent(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Invite an Identity to be an agent with permissions over this Asset

Parameters

NameType
argsInviteExternalAgentParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Note

this will create an Authorization Request which has to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Note

this method is of type ProcedureMethod, which means you can call inviteAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Asset/Base/Permissions/index.ts:83


removeAgent

removeAgent(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Revoke an agent's permissions over this Asset

Parameters

NameType
argsRemoveExternalAgentParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call removeAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Asset/Base/Permissions/index.ts:93