Skip to main content
Version: 23.0.x

Class: IdentityAuthorizations

api/entities/Identity/IdentityAuthorizations.IdentityAuthorizations

Handles all Identity Authorization related functionality

Hierarchy

Methods

getHistoricalAuthorizations

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

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

Note

supports pagination

Note

uses the middlewareV2

Parameters

NameTypeDescription
optsObject-
opts.size?BigNumberpage size
opts.start?BigNumberpage offset
opts.status?AuthorizationStatusEnumfetch only authorizations with this status. Fetches all statuses if not passed
opts.type?AuthTypeEnumfetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<ResultSet<AuthorizationRequest>>

Inherited from

Authorizations.getHistoricalAuthorizations


getOne

getOne(args): Promise<AuthorizationRequest>

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

Throws

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

Parameters

NameType
argsObject
args.idBigNumber

Returns

Promise<AuthorizationRequest>

Overrides

Authorizations.getOne


getReceived

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

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

Parameters

NameTypeDescription
opts?Object-
opts.includeExpired?booleanwhether to include expired authorizations. Defaults to true
opts.type?AuthorizationTypefetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<AuthorizationRequest[]>

Inherited from

Authorizations.getReceived


getSent

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

Fetch all pending authorization requests issued by this Identity

Note

supports pagination

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet<AuthorizationRequest>>