AuthorizationRequest
Last updated
Was this helpful?
Last updated
Was this helpful?
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
‹UniqueIdentifiers, ›
↳ AuthorizationRequest
• authId: BigNumber
internal identifier for the request (used to accept/reject/cancel)
Protected contextauthorization 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: 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
Identity that emitted the request
Identity or Account to which the request was emitted
• uuid: string
Accept the authorization request. You must be the target of the request to be able to accept it
Parameters:
Name
Type
args
void
opts?
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
â–¸ isExpired(): boolean
Returns whether the Authorization Request has expired
Returns: boolean
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
Parameters:
Name
Type
args
void
opts?
Return the Authorization's static data
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Defined in
• context:
Inherited from .
Defined in
• data:
Defined in
Defined in
• issuer:
Defined in
• target:
Defined in
Inherited from .
Defined in
▸ accept(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call accept.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
▸ remove(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
â–¸ toJson():
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in