Skip to content

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.

Admin Portal
Available on every plan
Enabled for your workspace
Configured by your customer
3Streaming to your systems

Because first impressions matter

Onboarding without the back-and-forth

1

Generate a Portal Link

One API call, scoped to a single organization and an intent: SSO or Directory Sync. A Portal Link is the gateway into the Admin Portal.

2

The IT admin configures it

They pick their identity provider, follow setup documentation written for that provider, and map their own attributes. No shared screens, no metadata over email.

3

They land back in your app

Set a return URL and the admin comes back where you want them, with a live connection behind them and nothing left in your support queue.

No code required

...or generate onboarding links without writing any code

Create an Admin Portal session in just a few clicks. Share the link as part of account onboarding over email, direct message or any other channel your team already uses.

  • Generate a session from the dashboard, no deploy involved
  • Send it however you already talk to the customer
  • Portal Links expire five minutes after they are created
  • Only resources belonging to that organization can be managed
No code required
Available on every plan
Enabled for your workspace
Configured by your customer
3Streaming to your systems

Always current

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

Every identity provider is different. Admin Portal carries the latest setup documentation for your customer, so your team can focus on what they do best: building and supporting your product.

  • Docs for all supported identity and directory providers
  • Step-by-step setup guides with detailed screenshots
  • Seamlessly integrated into your existing application
  • Always up to date with the latest setup information
Always current
Available on every plan
Enabled for your workspace
Configured by your customer
3Streaming to your systems

A polished experience for your customers

Everything the IT admin needs, nothing they don't

The screen your customer's IT team sees when they set your product up, without you designing, writing or maintaining it.

Flexible API designUse the same interface to create both Single Sign-On and Directory Sync links.
Pre-defined data structureMake sure that only resources belonging to the specified organization can be managed.
Session managementDon't worry about managing sessions. Portal Links expire five minutes after they are created.
Connect any provider or directoryEffortlessly connect any identity provider or directory, without your team learning each one.
Customize the look and feelMatch your brand, and host the portal on your own custom domain with a CNAME.
Customer-owned attribute mappingIT admins know their own directory fields best. Let them configure and map custom attributes to your schema.

Portal Links

Programmatically generate onboarding links

A Portal Link is a gateway into the Admin Portal. Each one onboards a single enterprise customer through a secure self-serve experience.

1// Generate a Portal Link to an SSO connection
2// and return to the app after it's done
3import Paycux from '@paycux/node';
4
5const paycux = new Paycux('sk_example_123456');
6
7const { link } = await paycux.portal.generateLink({
8 intent: 'sso',
9 organization: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
10 returnUrl: 'https://example.com',
11});

Transparent pricing

Priced by how you brand it

Enable enterprise customers to onboard through a secure self-serve experience. Un-branded access is included with the connections you already pay for; talk to us when you want the portal to look like your product.

Un-branded portal accessIncluded
Portal Link sessionsIncluded
Custom brandingContact us
Custom domain (CNAME)Contact us
Custom enterprise planContract-based

Questions

Frequently asked

What is a Portal Link?

A single-use gateway into the Admin Portal, scoped to one organization and one intent. You generate it from the API or the dashboard, hand it to the customer's IT admin, and they complete setup on their own.

How long is a link valid?

Portal Links expire five minutes after they are created, so a link forwarded to the wrong inbox is not a standing door into a customer's configuration. Generating a fresh one is a single call.

Can the admin only touch their own organization?

Yes. The link carries the organization it was created for, and the portal will not surface or modify resources belonging to anyone else.

Can it look like our product?

Yes. Set your logo and colours, and host the portal on your own domain with a CNAME so the admin never notices a handoff. Un-branded access works out of the box while you decide.

Do we have to write setup documentation for each provider?

No. That is most of the point. The portal ships current, provider-specific instructions with screenshots, and they are updated as the providers change their own admin consoles.

Give onboarding back to the people doing it

Send a link instead of scheduling a call. Your customer's IT team sets up SSO and Directory Sync on their own time, and your support queue stays empty.