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

Index

Properties

• authId

• context

• data

• expiry

• issuer

• target

• uuid

Methods

• accept

• exists

• isEqual

• isExpired

• remove

• toJson

• generateUuid

• unserialize

Properties

authId

• authId: BigNumber

Defined in src/api/entities/AuthorizationRequest.ts:99

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

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

data

• data: Authorization

Defined in src/api/entities/AuthorizationRequest.ts:88

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

Defined in src/api/entities/AuthorizationRequest.ts:94

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

Defined in src/api/entities/AuthorizationRequest.ts:70

Identity that emitted the request

---

target

• target: Signer

Defined in src/api/entities/AuthorizationRequest.ts:65

Identity or Account to which the request was emitted

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

accept

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

Defined in src/api/entities/AuthorizationRequest.ts:183

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

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/AuthorizationRequest.ts:212

Determine whether this Authorization Request exists on chain

Returns: Promise‹boolean›

---

isEqual

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

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

isExpired

▸ isExpired(): boolean

Defined in src/api/entities/AuthorizationRequest.ts:203

Returns whether the Authorization Request has expired

Returns: boolean

---

remove

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

Defined in src/api/entities/AuthorizationRequest.ts:196

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

---

toJson

▸ toJson(): HumanReadable

Overrides Entity.toJson

Defined in src/api/entities/AuthorizationRequest.ts:226

Return the Authorization's static data

Returns: HumanReadable

---

Static generateUuid

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

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

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

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers