Skip to content

Authentication

Authentication allows you to write records or read encrypted records. If you only need to read plaintext records, then you do not need authentication.

How it works

IDX uses DIDs for identifiers and authentication. Once a DID is authenticated using a DID provider, the authenticated DID provider needs to be set to the Ceramic instance used by your project. This will allow the user to perform authenticated transactions on IDX using their DID such as writing records and reading encrypted records.

Prerequisites

In order to add authentication, you must have installed the IDX SDK.

Installation

Jump over to the Ceramic documentation to learn how to add authentication to your project.

Example

After you have set the authenticated DID provider on the ceramic instance you can interact with your idx instance in an authenticated way. If configured correctly, it will look something like this:

ceramic.did = did
await idx.get('anAlias') // uses authenticated DID