core.client.getschema.md

Home > @cerbos/core > Client > getSchema

Client.getSchema() method

Fetch a schema by ID.

Signature:

getSchema(id: string, options?: RequestOptions): Promise<Schema | undefined>;

Parameters

Parameter	Type	Description
id	string
options	RequestOptions	(Optional)

Returns:

Promise<Schema | undefined>

Remarks

Requires

• the client to be configured with Options.adminCredentials, and

• the Cerbos policy decision point server to be configured with the admin API enabled.

Example

const schema = await cerbos.getSchema("document.json");