providers/boxyhq-saml

Built-in BoxyHQ SAML integration.

BoxyHQSAMLProfile

Extends

• Record<string, any>

Properties

email

email: string;

firstName?

optional firstName: string;

id

id: string;

lastName?

optional lastName: string;

default()

default<P>(options): OAuthConfig<P>

Add BoxyHQ SAML login to your page.

BoxyHQ SAML is an open source service that handles the SAML SSO login flow as an OAuth 2.0 flow, abstracting away all the complexities of the SAML protocol. Enable Enterprise single-sign-on in your app with ease.

You can deploy BoxyHQ SAML as a separate service or embed it into your app using our NPM library. Check out the documentation for more details

Setup

Callback URL

https://example.com/api/auth/callback/boxyhq-saml

Configuration

For OAuth 2.0 Flow:

import Auth from "@auth/core"
import BoxyHQ from "@auth/core/providers/boxyhq-saml"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [BoxyHQ({
   authorization: { params: { scope: "" } }, // This is needed for OAuth 2.0 flow, otherwise default to openid
   clientId: BOXYHQ_SAML_CLIENT_ID,
   clientSecret: BOXYHQ_SAML_CLIENT_SECRET,
   issuer: BOXYHQ_SAML_ISSUER
  })],
})

For OIDC Flow:

import Auth from "@auth/core"
import BoxyHQ from "@auth/core/providers/boxyhq-saml"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [BoxyHQ({
   clientId: BOXYHQ_SAML_CLIENT_ID,
   clientSecret: BOXYHQ_SAML_CLIENT_SECRET,
   issuer: BOXYHQ_SAML_ISSUER
  })],
})

Resources

• BoxyHQ OAuth documentation

Configuration

SAML login requires a configuration for every tenant of yours. One common method is to use the domain for an email address to figure out which tenant they belong to. You can also use a unique tenant ID (string) from your backend for this, typically some kind of account or organization ID.

Check out the documentation for more details.

On the client side you’ll need to pass additional parameters tenant and product to the signIn function. This will allow BoxyHQL SAML to figure out the right SAML configuration and take your user to the right SAML Identity Provider to sign them in.

import { signIn } from "next-auth/react";
...
 
  // Map your users's email to a tenant and product
  const tenant = email.split("@")[1];
  const product = 'my_awesome_product';
...
  <Button
    onClick={async (event) => {
      event.preventDefault();
 
      signIn("boxyhq-saml", {}, { tenant, product });
    }}>
...

Notes

By default, Auth.js assumes that the BoxyHQ provider is based on the OAuth 2 specification.

Type parameters

Parameters

Returns

OAuthConfig<P>