Skip to main content

Getting Started

Account Setup#

Making API Requests#

Everything in Warrant is accessible and editable via API. Requests can be made using any of our SDKs or directly to api.warrant.dev.

All requests must include your API Key. If making calls directly (ex. using cURL), include your key in the 'Authorization' header as follows: Authorization: ApiKey YOUR_KEY.

See API Reference for more details about supported operations. Follow these steps to get started with one of our SDKs:

Installation

npm install @warrantdev/warrant-node

Usage

const Warrant = require("@warrantdev/warrant-node");const warrantClient = new Warrant.Client("YOUR_KEY");

Usage (ES Modules)

import { Client as WarrantClient } from "@warrantdev/warrant-node";const warrantClient = new WarrantClient("YOUR_KEY");

Creating your Access Control Model#

Now that you have an account and API access, you need to set up your application's access model. This roughly consists of the following steps:

  • Create object types that represent your access control model
  • Hook up your users into Warrant
  • Create warrants
  • Start enforcing access checks in your application code

Check out the quickstart guide for a quick overview of these steps.

Client-side Integration (Optional)#

In addition to APIs that help you manage and enforce access rules on the back-end, Warrant also offers UI components for popular front-end frameworks like React and Vue that can help you build conditional, permission-driven web applications.

For example, you can wrap your 'Admin Page' with a Warrant component that will only render the page if the user has the applicable permission(s) in Warrant.

See this guide for more details on how to get set up.