Admin Portal

The Admin Portal is a standalone application where your users can configure and manage WorkOS resources such as Connections and Directories that are scoped to their Organization.

A Portal Link is a temporary endpoint to initiate an Admin Portal session. It expires five minutes after issuance.

https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Generate a Portal Link scoped to an Organization.

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

const workos = new WorkOS('sk_example_123456789');

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

Icons for third-party providers are available through the WorkOS CDN. These icons cover identity providers, Directory Sync, and domain verification services used within the Admin Portal.

Get a list of all of existing provider icons.

curl https://cdn.workos.com/provider-icons.json 

To use an icon in your project, you can reference the CDN link directly. You can alternate between light and dark mode icons by changing the path in the URL or using CSS media queries.

<picture>
  <source
    srcset="https://cdn.workos.com/provider-icons/dark/okta.svg"
    media="(prefers-color-scheme: dark)"
  />
  <img
    src="https://cdn.workos.com/provider-icons/light/okta.svg"
    alt="Okta icon"
  />
</picture>

You can change the icons to grayscale by adding the filter CSS property.

img {
  filter: grayscale(100%);
}