You are currently browsing legacy 4.0 version of documentation. Click here to switch to the newest 5.1 version.

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

Client API: Setting up Authentication and Authorization

Authentication and authorization is based on client X.509 certificates.

The authentication options argument in DocumentStore constructor property allows you to pass a certificate which will be used by the RavenDB client to connect to a server.


If your RavenDB server instance is served using https, then your application is required to use a client certificate in order to be able to access the server. You can find more information here.


import { DocumentStore } from "ravendb";
import * as fs from "fs";

// load certificate and prepare authentication options
const authOptions = {
    certificate: fs.readFileSync("C:\\ravendb\\client-cert.pfx"),
    type: "pfx", // or "pem"
    password: "my passphrase"

const store = new DocumentStore([ "https://my_secured_raven" ], "Northwind", authOptions);

// proceed with your work here