Constructors
Constructor
new ApproverApi(Defined in: typescript/src/client/ApproverApi.ts:25transport):ApproverApi
Parameters
transport
Transport
Returns
ApproverApi
Methods
list()
list():Defined in: typescript/src/client/ApproverApi.ts:31 Every approver key the server trusts or trusted, revoked ones marked. Maps to GET /approval-issuers.Promise<ApprovalIssuer[]>
Returns
Promise<ApprovalIssuer[]>
proposeChange()
proposeChange(Defined in: typescript/src/client/ApproverApi.ts:44 Proposes adding or revoking an approver key. Nothing changes until a different person approves it. Maps to POST /approval-issuers/changes.input):Promise<ApprovalIssuerChange>
Parameters
input
ProposeApproverChangeInput
Returns
Promise<ApprovalIssuerChange>
listChanges()
listChanges(Defined in: typescript/src/client/ApproverApi.ts:62 Lists approver changes, newest first. Maps to GET /approval-issuers/changes.status?):Promise<ApprovalIssuerChange[]>
Parameters
status?
PendingPolicyChangeStatus
Only changes in this state. Omit for all.
Returns
Promise<ApprovalIssuerChange[]>
approveChange()
approveChange(Defined in: typescript/src/client/ApproverApi.ts:85 Approves and applies an approver change. Maps to POST /approval-issuers/changes//approve. The caller must not be the proposer and must have a registered step up key. MakechangeId,stepUpAuthorization):Promise<ApprovalIssuerChange>
stepUpAuthorization with signPolicyChangeStepUp(), the change id
as pendingPolicyChangeId, and action “approve”.
Parameters
changeId
string
stepUpAuthorization
PolicyChangeStepUpAuthorization
Returns
Promise<ApprovalIssuerChange>
rejectChange()
rejectChange(Defined in: typescript/src/client/ApproverApi.ts:102 Rejects an approver change. Same caller rules as approveChange(); sign with action “reject”. A reason is required.changeId,rejectionReason,stepUpAuthorization):Promise<ApprovalIssuerChange>
Parameters
changeId
string
rejectionReason
string
stepUpAuthorization
PolicyChangeStepUpAuthorization
Returns
Promise<ApprovalIssuerChange>