Portal Link

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

Example Portal Link URL

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

Generate a Portal Link

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',
});

`portal.generateLink()`

`Parameters` `object`

`Returns` `object`

Provider IconsContinue to the next section

Up next

Portal Link

Generate a Portal Link

portal.generateLink()

Parameters object

organization: string

intent: string

returnUrl?: string

successUrl?: string

Returns object

link: string

`portal.generateLink()`

`Parameters` `object`

`Returns` `object`