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

Methods

Properties

authId

• authId: BigNumber

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

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

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

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

Identity that emitted the request

target

• target: Signer

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

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(args: void): Promise‹TransactionQueue‹void››

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

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

Returns: Promise‹TransactionQueue‹void››

isEqual

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

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown›

Returns: boolean

isExpired

▸ isExpired(): boolean

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

Returns whether the Authorization Request has expired

Returns: boolean

remove

▸ remove(args: void): Promise‹TransactionQueue‹void››

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

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

Returns: Promise‹TransactionQueue‹void››

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

PreviousAccountNextAuthorizations

Last updated