Permissions
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Permissions related functionality Permissions a Secondary Key has over the Identity. A null value means the key has all permissions of that type (i.e. if tokens is null, the key has permissions over all of the Identity's Security Tokens)
Namespace‹›
↳ Permissions
Protected contextInherited from void
Protected parentInherited from void
Security Tokens over which this key has permissions
list of Transaction Groups this key can execute. Having permissions over a TxGroup means having permissions over every TxTag in said group. Partial group permissions are not covered by this value. For a full picture of transaction permissions, see the transactions property
NOTE: If transactions is null, ignore this value
Transactions this key can execute
Create a Permission group for this Security Token. Identities can then be assigned to said group as Agents. Agents assigned to a group have said group's permissions over this Security Token
Parameters:
args
opts?
Retrieve a list of Agents (Identities which have permissions over the Security Token) and their respective Permission Groups
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
id
BigNumber
Parameters:
â–ª args: object
type
▸ getGroups(): Promise‹object›
Retrieve all Permission Groups of this Security Token
Returns: Promise‹object›
Invite an Identity to be an Agent with permissions over this Security Token
Parameters:
args
opts?
Revoke an Agent's permissions for this Security Token
Parameters:
args
opts?
• context:
Defined in
• parent:
Defined in
• portfolios: ‹ | › | null
Defined in
• tokens: ‹› | null
Defined in
• transactionGroups: []
Defined in
• transactions: | null
Defined in
▸ createGroup(args: , opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call createGroup.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ getAgents(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getGroup(args: object): Promise‹›
Defined in
Returns: Promise‹›
▸ getGroup(args: object): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ inviteAgent(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call inviteAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ removeAgent(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call removeAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››