JSPM

  • Created
  • Published
  • Downloads 9801
  • Score
    100M100P100Q136568F
  • License Apache-2.0

JavaScript and TypeScript library to provide a simple integration with an IC Internet Identity

Package Exports

  • @dfinity/auth-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dfinity/auth-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@dfinity/auth-client

Simple interface to get your web application authenticated with the Internet Identity Service

Visit the Dfinity Forum and SDK Documentation for more information and support building on the Internet Computer.

Additional API Documentation can be found here.


Installation

Using AuthClient:

npm i --save @dfinity/auth-client

In the browser:

import { AuthClient } from "@dfinity/auth-client";

To get started with auth client, run

const authClient = await AuthClient.create();

The authClient can log in with

authClient.login({
  onSuccess: async () => {
    // authClient now has an identity
  },
});

It opens an identity.ic0.app window, saves your delegation to localStorage, and then sets you up with an identity.

Then, you can use that identity to make authenticated calls using the @dfinity/agent Actor.

const identity = await authClient.getIdentity();
const actor = Actor.createActor(idlFactory, {
  agent: new HttpAgent({
    identity,
  }),
  canisterId,
});

Note: depends on @dfinity/agent, @dfinity/authentication, and @dfinity/identity.