Sign in with Octave

#Installation

1. 01

   Install the SDK

   Add @octave-ams/auth-sdk to your app.

   pnpm add @octave-ams/auth-sdk

2. 02

   Create a client

   Use the domain and client ID from your app registration, and the URL Octave should return to after sign-in.

   import { OctaveAuthClient } from "@octave-ams/auth-sdk";
   
   export const auth = new OctaveAuthClient({
     domain: "https://YOUR_POOL.auth.us-east-1.amazoncognito.com",
     clientId: "YOUR_CLIENT_ID",
     redirectUri: "http://localhost:3000/auth/callback",
   });

3. 03

   Send people to sign in

   Redirects to the hosted sign-in page with a PKCE challenge.

   await auth.signInRedirect();

4. 04

   Handle the callback

   On your redirect URI, exchange the code for tokens. The state and PKCE verifier are checked for you.

   const tokens = await auth.handleCallback();
   // tokens.accessToken, tokens.idToken, tokens.refreshToken

5. 05

   Sign out

   Ends the session at Octave and returns to your logout URI.

   auth.signOutRedirect();