Skip to main content
Defined in: typescript/src/client/ExternalConnectorApi.ts:25

​
Constructors

​
Constructor

new ExternalConnectorApi(transport): ExternalConnectorApi
Defined in: typescript/src/client/ExternalConnectorApi.ts:26

​
Parameters

transport
Transport

​
Returns

ExternalConnectorApi

​
Methods

​
list()

list(): Promise<ExternalConnector[]>
Defined in: typescript/src/client/ExternalConnectorApi.ts:32 Every registration, active and revoked. Maps to GET /external-connectors.

​
Returns

Promise<ExternalConnector[]>

​
proposeChange()

proposeChange(input): Promise<ExternalConnectorChange>
Defined in: typescript/src/client/ExternalConnectorApi.ts:48 Proposes registering or revoking an external connector. Nothing changes until a different person approves it. Maps to POST /external-connectors/changes.

​
Parameters

input
ProposeExternalConnectorChangeInput

​
Returns

Promise<ExternalConnectorChange>

​
listChanges()

listChanges(status?): Promise<ExternalConnectorChange[]>
Defined in: typescript/src/client/ExternalConnectorApi.ts:66 Lists external connector changes, newest first. Maps to GET /external-connectors/changes.

​
Parameters

status?
PendingPolicyChangeStatus Only changes in this state. Omit for all.

​
Returns

Promise<ExternalConnectorChange[]>

​
approveChange()

approveChange(changeId, stepUpAuthorization): Promise<ExternalConnectorChange>
Defined in: typescript/src/client/ExternalConnectorApi.ts:89 Approves and applies an external connector change. Maps to POST /external-connectors/changes//approve. The caller must not be the proposer and must have a registered step up key. Make stepUpAuthorization with signPolicyChangeStepUp(), the change id as pendingPolicyChangeId, and action “approve”.

​
Parameters

changeId
string
stepUpAuthorization
PolicyChangeStepUpAuthorization

​
Returns

Promise<ExternalConnectorChange>

​
rejectChange()

rejectChange(changeId, rejectionReason, stepUpAuthorization): Promise<ExternalConnectorChange>
Defined in: typescript/src/client/ExternalConnectorApi.ts:106 Rejects an external connector change. Same caller rules as approveChange(); sign with action “reject”. A reason is required.

​
Parameters

changeId
string
rejectionReason
string
stepUpAuthorization
PolicyChangeStepUpAuthorization

​
Returns

Promise<ExternalConnectorChange>