core.options.md

Home > @cerbos/core > Options

Options interface

Options for creating a new Client.

Signature:

export interface Options 

Properties

Property	Modifiers	Type	Description
adminCredentials?		AdminCredentials | undefined	(Optional) Credentials for the admin API.
headers?		HeadersInit | (() => HeadersInit | Promise<HeadersInit>) | undefined	(Optional) Headers to add to every request to the policy decision point.
onValidationError?		"throw" | ValidationFailedCallback | undefined	(Optional) Action to take when input fails schema validation.
playgroundInstance?		string | undefined	(Optional) Identifier of the playground instance to use when prototyping against the hosted demo policy decision point.
userAgent?		string | undefined	(Optional) Custom user agent to prepend to the built-in value.