Admin Portal

Self-serve onboarding for your enterprise customers

A secure, fully customizable, and always up-to-date onboarding experience for your customers’ IT team.

Because first impressions matter

Empower your customers to onboard with a secure self-serve Admin Portal. Set up SSO or Directory Sync, without back-and-forth support requests.

Programmatically generate onboarding links

A Portal Link is a gateway to accessing the Admin Portal. Each Portal Link can be used to onboard enterprise customers with a secure self-serve experience.

Read the docs

Get your API key


// Generate a Portal Link to a SSO connection
// and return to the app after it's done

import WorkOS from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456');

const { link } = await workos.portal.generateLink({
  intent: 'sso',
  organization: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
  returnUrl: 'https://example.com'
});


# Generate a Portal Link to a SSO connection
# and return to the app after it's done

require 'workos'

WorkOS.key = 'sk_example_123456'

link = WorkOS::Portal.generate_link(
  intent: 'sso',
  organization: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
  return_url: 'https://example.com'
)


# Generate a Portal Link to a SSO connection
# and return to the app after it's done

import workos
from workos import client

workos.api_key = 'sk_example_123456'
workos.client_id = 'client_123456'

link = client.portal.generate_link(intent='sso', organization='org_01EHZNVPK3SFK441A1RGBFSHRT', return_url='https://example.com')


// Generate a Portal Link to a SSO connection
// and return to the app after it's done

import "github.com/workos/workos-go/pkg/portal"

portal.SetAPIKey("sk_example_123456")

link, err := portal.GenerateLink(
  context.Background(),
  portal.GenerateLinkOpts{
    Intent: portal.SSO,
    Organization: "org_01EHZNVPK3SFK441A1RGBFSHRT",
    ReturnURL: "https://example.com"
  },
)


// Generate a Portal Link to a SSO connection
// and return to the app after it's done

$this->ap = new AdminPortal();

$link = $this->ap->generateLink("org_01EHZNVPK3SFK441A1RGBFSHRT", "sso", "https://example.com");


// Generate a Portal Link to a SSO connection
// and return to the app after it's done

import com.workos.WorkOS;

WorkOS workos = new WorkOS("sk_example_123456");

Link link = workos.portal.generateLink(
  GeneratePortalLinkOptions.builder()
    .intent(Intent.Sso)
    .organization("org_01EHZNVPK3SFK441A1RGBFSHRT")
    .return_url("https://example.com")
    .build()
);


// Generate a Portal Link to a SSO connection
// and return to the app after it's done

WorkOS.SetApiKey("sk_example_123456");

var portalService = new PortalService();
var options = new GenerateLinkOptions
{
  Intent = Intent.SSO,
  Organization = "org_01EHZNVPK3SFK441A1RGBFSHRT",
  ReturnURL = "https://example.com"
};

var link = await portalService.GenerateLink(options);


curl --request POST \
  --url "https://api.workos.com/portal/generate_link" \
  --header "Authorization: Bearer sk_example_123456" \
  -d intent="sso" \
  -d organization="org_01EHZNVPK3SFK441A1RGBFSHRT" \
  -d return_url="https://example.com"

Flexible API design
Use the same interface to create both Single Sign-On and Directory Sync links.
Pre-defined data structure
Make sure that only resources belonging to the specified Organization can be managed
Session management
Don't worry about managing sessions. Portal Links expire 5 minutes after they’re created.

...or generate onboarding links without writing any code

Create an Admin Portal session in just a few clicks — no code required. Share the link as a part of account onboarding via emails, direct messaging or other channels.

Read the docs

We keep updated docs, so you don’t have to

Every Identity Provider is different. Admin Portal has the latest setup documentation for your customer so that your team can focus on what they do best, building and supporting your product.

Try a live demo

Watch the launch video

Docs for all supported identity and directory providers
Step-by-step setup guides and screenshots
Seamlessly integrated into your existing application
Always up-to-date with the latest setup information

Enable your customers to
map their own attributes

IT admins best know the fields offered by their directory providers. Let them configure and map custom attributes depending on their company's requirements.

Read the docs