Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
Getting Started
Providers
Sailpoint

SailPoint ISC Provider

SailPoint Identity Secure Cloud (ISC) is an enterprise SaaS platform for identity and security. In order to use this OAuth integration, you will need an ISC tenant. If you’re a SailPoint customer or partner, please talk to your SailPoint account manager for more details. If you are a developer, check out the SailPoint Developer Community.

💡

This provider is not shipped with any of the Auth.js packages because it is an enterprise provider for which we cannot obtain a tenant to test and ensure compatibility. That being said, we’d like to make providers like these available to our users, so we will share a copy and paste version of the provider on respective docs pages like this. The provider configuration below is provided as-is and has been submitted by a community member with access to a SailPoint tenant.

Resources

Setup

Callback URL

https://example.com/api/auth/callback/sailpoint

Create OAuth Client

First, you’ll need to create a client in your SailPoint admin console in order to get your clientId and clientSecret. You can follow this guide, or follow the main steps below.

  1. Create an OAuth Client () with grant types: AUTHORIZATION_TOKEN and REFRESH_TOKEN.
  2. Set the redirect URL to match your callback URL, based on the example above.
  3. Finally, select the scopes sp:scope:all.
  4. Click “Create” and note down the generated clientId and clientSecret.

Environment Variables

AUTH_SAILPOINT_ID=
AUTH_SAILPOINT_SECRET=
AUTH_SAILPOINT_BASE_URL=https://{tenant}.identitynow.com
AUTH_SAILPOINT_BASE_API_URL=https://{tenant}.api.identitynow.com

Configuration

Unlike other Auth.js providers, this cannot be imported from the package (see the note at the top of this page for more details). However, you can copy and paste the following object into your providers array to enable this provider.

/auth.ts
import NextAuth from "next-auth"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    {
      id: "sailpoint",
      name: "SailPoint",
      type: "oauth",
      clientId: process.env.AUTH_SAILPOINT_ID!,
      clientSecret: process.env.AUTH_SAILPOINT_SECRET!,
      authorization: {
        url: `${process.env.AUTH_SAILPOINT_BASE_URL!}/oauth/authorize`,
        params: { scope: "sp:scopes:all" },
      },
      token: `${process.env.AUTH_SAILPOINT_BASE_API_URL!}/oauth/token`,
      userinfo: `${process.env.AUTH_SAILPOINT_BASE_API_URL!}/oauth/userinfo`,
      profile(profile) {
        return {
          id: profile.id,
          email: profile.email,
          name: profile.uid,
          image: null,
        }
      },
      style: { brandColor: "#011E69", logo: "sailpoint.svg" },
    },
  ],
})

Profile

The SailPoint userprofile endpoint will return more fields, but by default the User table only supports id, name, email, and image. Therefore, if you’d like to use any of the following fields and you’re using a database adapter with Auth.js, make sure you modify the User table schema in whichever adapter and database you’re using. Then you can additionally return any of these fields from the profile callback above.

The available fields from the SailPoint userprofile endpoint response include the following.

type SailPointProfile = {
  tenant: string
  id: string
  uid: string
  email: string
  phone: string
  workPhone: string
  firstname: string
  lastname: string
  capabilities: string
  displayName: string
  name: string
}
Auth.js © Balázs Orbán and Team - 2024