AuthorizationRequest
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 her asset ALICETOKEN to Bob, an authorization request gets emitted to Bob, who then has to accept it in order for the ownership transfer to be complete

Hierarchy

Index

Properties

Methods

Properties

authId

authId: BigNumber
internal identifier for the request (used to accept/reject/cancel)

Protected context

context: Context
Inherited from Entity.context

data

data: Authorization
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
DID
Transfer Ticker
Ticker
Add MultiSig Signer
Account
Transfer Token Ownership
Ticker
Join Identity
DID
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

issuer: Identity
Identity that emitted the request

target

target: Signer
Identity or Account to which the request was emitted

uuid

uuid: string
Inherited from Entity.uuid

Methods

accept

accept(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Accept the authorization request. You must be the target of the request to be able to accept it
note this method is of type ProcedureMethod, which means you can call accept.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Authorization Request exists on chain
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

isExpired

isExpired(): boolean
Returns whether the Authorization Request has expired
Returns: boolean

remove

remove(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Authorization's static data
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago