Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • authId
  • Protected context
  • data
  • expiry
  • issuer
  • target
  • uuid
  • Methods
  • accept
  • exists
  • isEqual
  • isExpired
  • remove
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

AuthorizationRequest

PreviousAssetsNextAuthorizations

Last updated 2 years ago

Was this helpful?

Represents a request made by an Identity to another Identity (or Account) for some sort of authorization. This has multiple uses. For example, if Alice wants to transfer ownership of one of her Assets to Bob, this method emits an authorization request for Bob, who then has to accept it in order to complete the ownership transfer

Hierarchy

  • ‹UniqueIdentifiers, ›

    ↳ AuthorizationRequest

Index

Properties

Methods

Properties

authId

• authId: BigNumber

internal identifier for the Request (used to accept/reject/cancel)


Protected context

• context: Context


data

Authorization Request data corresponding to type of Authorization

Type
Data

Add Relayer Paying Key

Beneficiary, Relayer, Allowance

Become Agent

Permission Group

Attest Primary Key Rotation

DID

Rotate Primary Key

N/A

Rotate Primary Key to Secondary

Permissions

Transfer Ticker

Ticker

Add MultiSig Signer

Account

Transfer Asset Ownership

Ticker

Join Identity

Permissions

Portfolio Custody

Portfolio


expiry

• expiry: Date | null

date at which the Authorization Request expires and can no longer be accepted. At this point, a new Authorization Request must be emitted. Null if the Request never expires


issuer

Identity that emitted the request


target

Identity or Account to which the request was emitted


uuid

• uuid: string

Methods

accept

Accept the Authorization Request. You must be the target of the Request to be able to accept it

Parameters:

Name
Type

opts?


exists

▸ exists(): Promise‹boolean›

Determine whether this Authorization Request exists on chain

Returns: Promise‹boolean›


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


isExpired

â–¸ isExpired(): boolean

Returns whether the Authorization Request has expired

Returns: boolean


remove

Remove the Authorization Request

  • If you are the Request issuer, this will cancel the Authorization

  • If you are the Request target, this will reject the Authorization

Parameters:

Name
Type

opts?


toHuman

Return the Authorization's static data


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Defined in

Inherited from .

Defined in

• data:

Defined in

Defined in

• issuer:

Defined in

• target:

Defined in

Inherited from .

Defined in

▸ accept(opts?: ): Promise‹‹void››

Defined in

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

Returns: Promise‹‹void››

Overrides .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Defined in

▸ remove(opts?: ): Promise‹‹void››

Defined in

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

Returns: Promise‹‹void››

â–¸ toHuman():

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/AuthorizationRequest.ts:99
src/api/entities/Entity.ts:48
src/api/entities/AuthorizationRequest.ts:88
src/api/entities/AuthorizationRequest.ts:94
Identity
src/api/entities/AuthorizationRequest.ts:70
src/api/entities/AuthorizationRequest.ts:65
src/api/entities/Entity.ts:46
ProcedureOpts
TransactionQueue
src/api/entities/AuthorizationRequest.ts:183
NoArgsProcedureMethod
accept.checkAuthorization
TransactionQueue
src/api/entities/AuthorizationRequest.ts:212
Entity
src/api/entities/Entity.ts:61
src/api/entities/AuthorizationRequest.ts:203
ProcedureOpts
TransactionQueue
src/api/entities/AuthorizationRequest.ts:196
NoArgsProcedureMethod
remove.checkAuthorization
TransactionQueue
HumanReadable
src/api/entities/AuthorizationRequest.ts:226
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
HumanReadable
authId
context
data
expiry
issuer
target
uuid
accept
exists
isEqual
isExpired
remove
toHuman
generateUuid
unserialize
ProcedureOpts
Entity
ProcedureOpts
CheckpointSchedule
CheckpointSchedule
Entity
CheckpointSchedule
Entity
CheckpointSchedule
CheckpointSchedule
exists
toHuman
context
uuid
isEqual
generateUuid
unserialize
Authorization
Signer