Polymesh SDK API Reference
v8.0.0
v8.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • Agent
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenIdentifier
    • TransactionPermissions
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • portfolios
  • tokens
  • transactionGroups
  • transactions
  • Methods
  • createGroup
  • getAgents
  • getGroups
  • inviteAgent
  • removeAgent

Was this helpful?

  1. Classes

Permissions

PreviousPermissionGroupNextPolymesh

Last updated 3 years ago

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)

Hierarchy

  • Namespace‹›

    ↳ Permissions

Index

Properties

Methods

Properties

Protected context

Inherited from void

Protected parent

Inherited from void

portfolios

tokens

Security Tokens over which this key has permissions

transactionGroups

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

Transactions this key can execute

Methods

createGroup

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:

Name

Type

args

opts?

getAgents

Retrieve a list of external agents of the Security Token

getGroups

▸ getGroups(): Promise‹object›

Retrieve all group permissions of the Security Token

Returns: Promise‹object›

inviteAgent

Invite an Identity to be an Agent with permissions over this Security Token

Parameters:

Name

Type

args

opts?

removeAgent

Revoke an Agent's permissions for this Security Token

Parameters:

Name

Type

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‹[]›

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››

Context
src/api/entities/Namespace.ts:11
SecurityToken
src/api/entities/Namespace.ts:9
SectionPermissions
DefaultPortfolio
NumberedPortfolio
src/types/index.ts:727
SectionPermissions
SecurityToken
src/types/index.ts:713
TxGroup
src/types/index.ts:725
TransactionPermissions
src/types/index.ts:717
CreateGroupParams
ProcedureOpts
TransactionQueue
CustomPermissionGroup
src/api/entities/SecurityToken/Permissions.ts:60
ProcedureMethod
TransactionQueue
CustomPermissionGroup
AgentWithGroup
src/api/entities/SecurityToken/Permissions.ts:123
AgentWithGroup
src/api/entities/SecurityToken/Permissions.ts:87
InviteExternalAgentParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/Permissions.ts:70
ProcedureMethod
TransactionQueue
RemoveExternalAgentParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/Permissions.ts:80
ProcedureMethod
TransactionQueue
SecurityToken
context
parent
portfolios
tokens
transactionGroups
transactions
createGroup
getAgents
getGroups
inviteAgent
removeAgent
CreateGroupParams
ProcedureOpts
InviteExternalAgentParams
ProcedureOpts
RemoveExternalAgentParams
ProcedureOpts