api_entities_Asset_Permissions.Permissions
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Permissions
.Permissions
Handles all Asset Permissions related functionality
Namespace<>
↳ Permissions
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
args
opts?
Returns
Defined in
Retrieve a list of agents (Identities which have permissions over the Asset) and their respective Permission Groups
Returns
Defined in
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
throws if there is no Permission Group with the passed ID
Parameters
args
Object
args.id
BigNumber
Returns
Defined in
Parameters
args
Object
args.type
Returns
Defined in
Retrieve all Permission Groups of this Asset
Returns
Defined in
Invite an Identity to be an agent with permissions over this Asset
Parameters
args
opts?
Returns
Defined in
â–¸ removeAgent(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Revoke an agent's permissions over this Asset
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ createGroup(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ getAgents(): Promise<[]>
Promise<[]>
â–¸ getGroup(args): Promise<>
Promise<>
â–¸ getGroup(args): Promise<>
Promise<>
â–¸ getGroups(): Promise<>
Promise<>
â–¸ inviteAgent(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this will create an which has to be accepted by the target Identity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it