Class: IdentityAuthorizations

Defined in: src/api/entities/Identity/IdentityAuthorizations.ts:12

Handles all Identity Authorization related functionality

Extends

• Authorizations<Identity>

Methods

getHistoricalAuthorizations()

getHistoricalAuthorizations(opts?: object): Promise<ResultSet<AuthorizationRequest>>

Defined in: src/api/entities/common/namespaces/Authorizations.ts:159

Fetch all historical Authorization Requests for which this Signer is the target

Parameters

Parameter	Type	Description
opts	{ size?: BigNumber; start?: BigNumber; status?: AuthorizationStatusEnum; type?: AuthTypeEnum; }	‐
opts.size?	BigNumber	page size
opts.start?	BigNumber	page offset
opts.status?	AuthorizationStatusEnum	fetch only authorizations with this status. Fetches all statuses if not passed
opts.type?	AuthTypeEnum	fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<ResultSet<AuthorizationRequest>>

Note

supports pagination

Note

uses the middlewareV2

Inherited from

Authorizations.getHistoricalAuthorizations

---

getOne()

getOne(args: object): Promise<AuthorizationRequest>

Defined in: src/api/entities/Identity/IdentityAuthorizations.ts:60

Retrieve a single Authorization Request targeting or issued by this Identity by its ID

Parameters

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Returns

Promise<AuthorizationRequest>

Throws

if there is no Authorization Request with the passed ID targeting or issued by this Identity

Overrides

Authorizations.getOne

---

getReceived()

getReceived(opts?: object): Promise<AuthorizationRequest[]>

Defined in: src/api/entities/common/namespaces/Authorizations.ts:42

Fetch all pending Authorization Requests for which this Signer is the target

Parameters

Parameter	Type	Description
opts?	{ includeExpired?: boolean; type?: AuthorizationType; }	‐
opts.includeExpired?	boolean	whether to include expired authorizations. Defaults to true
opts.type?	AuthorizationType	fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<AuthorizationRequest[]>

Inherited from

Authorizations.getReceived

---

getSent()

getSent(paginationOpts?: PaginationOptions): Promise<ResultSet<AuthorizationRequest>>

Defined in: src/api/entities/Identity/IdentityAuthorizations.ts:18

Fetch all pending authorization requests issued by this Identity

Parameters

Parameter	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<AuthorizationRequest>>

Note

supports pagination