api_entities_AuthorizationRequest.AuthorizationRequest

@polymeshassociation/polymesh-sdk / Modules / api/entities/AuthorizationRequest / AuthorizationRequest

Class: AuthorizationRequest

api/entities/AuthorizationRequest.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 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

• Entity<UniqueIdentifiers, HumanReadable>

  ↳ AuthorizationRequest

Table of contents

Properties

• authId

• data

• expiry

• issuer

• target

• uuid

Methods

• accept

• exists

• isEqual

• isExpired

• remove

• toHuman

• generateUuid

• unserialize

Properties

authId

• authId: BigNumber

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

Defined in

api/entities/AuthorizationRequest.ts:99

---

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

Defined in

api/entities/AuthorizationRequest.ts:88

---

expiry

• expiry: null | Date

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

Defined in

api/entities/AuthorizationRequest.ts:94

---

issuer

• issuer: Identity

Identity that emitted the request

Defined in

api/entities/AuthorizationRequest.ts:70

---

target

• target: Signer

Identity or Account to which the request was emitted

Defined in

api/entities/AuthorizationRequest.ts:65

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

accept

▸ accept(opts?): Promise<TransactionQueue<void, void, unknown[][]>>

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

note this method is of type NoArgsProcedureMethod, which means you can call accept.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in

api/entities/AuthorizationRequest.ts:183

---

exists

▸ exists(): Promise<boolean>

Determine whether this Authorization Request exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/AuthorizationRequest.ts:212

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

isExpired

▸ isExpired(): boolean

Returns whether the Authorization Request has expired

Returns

boolean

Defined in

api/entities/AuthorizationRequest.ts:203

---

remove

▸ remove(opts?): Promise<TransactionQueue<void, void, unknown[][]>>

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 NoArgsProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in

api/entities/AuthorizationRequest.ts:196

---

toHuman

▸ toHuman(): HumanReadable

Return the Authorization's static data

Returns

HumanReadable

Overrides

Entity.toHuman

Defined in

api/entities/AuthorizationRequest.ts:226

---

generateUuid

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

Name	Type
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14

---

unserialize

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

Name	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23