Class: IdentityAuthorizations
api/entities/Identity/IdentityAuthorizations.IdentityAuthorizations
Handles all Identity Authorization related functionality
Hierarchy
-
↳
IdentityAuthorizations
Methods
getHistoricalAuthorizations
▸ getHistoricalAuthorizations(opts?): Promise<ResultSet<AuthorizationRequest>>
Fetch all historical Authorization Requests for which this Signer is the target
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
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
Defined in
api/entities/common/namespaces/Authorizations.ts:147
getOne
▸ getOne(args): Promise<AuthorizationRequest>
Retrieve a single Authorization Request targeting or issued by this Identity by its ID
Parameters
| Name | Type |
|---|---|
args | Object |
args.id | BigNumber |
Returns
Promise<AuthorizationRequest>
Throws
if there is no Authorization Request with the passed ID targeting or issued by this Identity
Overrides
Defined in
api/entities/Identity/IdentityAuthorizations.ts:60
getReceived
▸ getReceived(opts?): Promise<AuthorizationRequest[]>
Fetch all pending Authorization Requests for which this Signer is the target
Parameters
| Name | Type | Description |
|---|---|---|
opts? | Object | - |
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
Defined in
api/entities/common/namespaces/Authorizations.ts:41
getSent
▸ getSent(paginationOpts?): Promise<ResultSet<AuthorizationRequest>>
Fetch all pending authorization requests issued by this Identity
Parameters
| Name | Type |
|---|---|
paginationOpts? | PaginationOptions |
Returns
Promise<ResultSet<AuthorizationRequest>>
Note
supports pagination