Class OPAClient

OPAClient is the starting point for using the high-level API.

Use OpaApiClient if you need some low-level customization.

Index

Constructors

Methods

evaluate evaluateBatch evaluateDefault fallbackBatch

Constructors

constructor

new OPAClient(serverURL, opts?): OPAClient
Create a new OPA instance.
Parameters
- serverURL: string
  The OPA URL, e.g. https://opa.internal.corp:8443/.
- Optionalopts: Options
  Extra options, including low-level SDKOptions.
Returns OPAClient
- Defined in packages/opa/src/opaclient.ts:88

Methods

evaluate

evaluate<In, Res>(path, input?, opts?): Promise<Res>
evaluate is used to evaluate the policy at the specified path with optional input.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- path: string
  The path to the policy, without /v1/data: use authz/allow to evaluate policy data.authz.allow.
- Optionalinput: In
  The input to the policy, if needed.
- Optionalopts: RequestOptions<Res>
  Per-request options to control how the policy evaluation result is to be transformed into Res (via fromResult), and low-level fetch options.
Returns Promise<Res>
- Defined in packages/opa/src/opaclient.ts:111

evaluateBatch

evaluateBatch<In, Res>(path, inputs, opts?): Promise<{
[k: string]: Res | ServerErrorWithStatusCode;
}>
evaluateBatch is used to evaluate the policy at the specified path, for a batch of many inputs.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- path: string
  The path to the policy, without /v1/batch/data: use authz/allow to evaluate policy data.authz.allow.
- inputs: {
  [k: string]: In;
  }
  The inputs to the policy.
  - [k: string]: In
- Optionalopts: BatchRequestOptions<Res>
  Per-request options to control how the policy evaluation result is to be transformed into Res (via fromResult), if any failures in the batch result should reject the promose (via rejectMixed), and low-level fetch options.
Returns Promise<{
[k: string]: Res | ServerErrorWithStatusCode;
}>
- Defined in packages/opa/src/opaclient.ts:176

evaluateDefault

evaluateDefault<In, Res>(input?, opts?): Promise<Res>
evaluateDefault is used to evaluate the server's default policy with optional input.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- Optionalinput: In
  The input to the default policy, defaults to {}.
- Optionalopts: RequestOptions<Res>
  Per-request options to control how the policy evaluation result is to be transformed into Res (via fromResult), and low-level fetch options.
Returns Promise<Res>
- Defined in packages/opa/src/opaclient.ts:148

fallbackBatch

fallbackBatch<Res>(path, inputs, opts?): Promise<{
[k: string]: ServerErrorWithStatusCode | SuccessfulPolicyResponse;
}>
Type Parameters
- Res
Parameters
- path: string
- inputs: {
  [k: string]: Input;
  }
  - [k: string]: Input
- Optionalopts: BatchRequestOptions<Res>
Returns Promise<{
[k: string]: ServerErrorWithStatusCode | SuccessfulPolicyResponse;
}>
- Defined in packages/opa/src/opaclient.ts:226