Class OpaApiClient

Hierarchy

ClientSDK
- OpaApiClient

Index

Constructors

Methods

executeDefaultPolicyWithInput executePolicy executePolicyWithInput health

Constructors

constructor

new OpaApiClient(options?): OpaApiClient
Parameters
- options: SDKOptions = {}
Returns OpaApiClient
Overrides ClientSDK.constructor
- Defined in src/sdk/sdk.ts:18

Methods

executeDefaultPolicyWithInput

executeDefaultPolicyWithInput(input, pretty?, acceptEncoding?, options?): Promise<ExecuteDefaultPolicyWithInputResponse>
Execute the default decision given an input
Parameters
- input: Input
- Optional pretty: boolean
- Optional acceptEncoding: Gzip
- Optional options: RequestOptions
Returns Promise<ExecuteDefaultPolicyWithInputResponse>
- Defined in src/sdk/sdk.ts:45

executePolicy

executePolicy(request, options?): Promise<ExecutePolicyResponse>
Execute a policy
Parameters
- request: ExecutePolicyRequest
- Optional options: RequestOptions
Returns Promise<ExecutePolicyResponse>
- Defined in src/sdk/sdk.ts:157

executePolicyWithInput

executePolicyWithInput(request, options?): Promise<ExecutePolicyWithInputResponse>
Execute a policy given an input
Parameters
- request: ExecutePolicyWithInputRequest
- Optional options: RequestOptions
Returns Promise<ExecutePolicyWithInputResponse>
- Defined in src/sdk/sdk.ts:283

health

health(bundles?, plugins?, excludePlugin?, options?): Promise<HealthResponse>
Verify the server is operational
Parameters
- Optional bundles: boolean
- Optional plugins: boolean
- Optional excludePlugin: string[]
- Optional options: RequestOptions
Returns Promise<HealthResponse>
Remarks
The health API endpoint executes a simple built-in policy query to verify that the server is operational. Optionally it can account for bundle activation as well (useful for “ready” checks at startup).
- Defined in src/sdk/sdk.ts:424