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

• Entity‹UniqueIdentifiers›

  ↳ AuthorizationRequest

Index

Properties

• authId

• context

• data

• expiry

• issuer

• target

• uuid

Methods

• accept
• isExpired
• remove
• generateUuid
• unserialize

Properties

authId

• authId: BigNumber

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

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

Protected context

• context: Context

Inherited from Entity.context

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

data

• data: Authorization

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

authorization request data corresponding to type of authorization

Type	Data
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
Custom	Custom
No Data	N/A

expiry

• expiry: Date | null

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

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

Identity that emitted the request

target

• target: Signer

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

Identity or Account to which the request was emitted

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

accept

▸ accept(): Promise‹TransactionQueue›

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

Accept the authorization request. You must be the target of the request to be able to accept it

Returns: Promise‹TransactionQueue›

isExpired

▸ isExpired(): boolean

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

Returns whether the Authorization Request has expired

Returns: boolean

remove

▸ remove(): Promise‹TransactionQueue›

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

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

Returns: Promise‹TransactionQueue›

Static generateUuid

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

Inherited from Entity.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

Static unserialize

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

Inherited from Entity.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers: object

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers