For AI agents: this page in Markdown: https://www.pubnub.com/docs/security/admin-portal-sso.md. Documentation index: https://www.pubnub.com/llms-full.txt.

Set up single sign-on for the Admin Portal

Set up SAML single sign-on (SSO) so members of your organization log in to the Admin Portal with your organization's identity provider (IdP). SSO is available on the Pro plan. For the features in each plan, refer to Features by plan.

Before you start​

Confirm you have:

  • A Pro plan.
  • Someone who can configure your IdP, usually your IT team. For questions about the IdP configuration, contact your IdP.

Configure your identity provider​

Follow your IdP's guide to create an application for the Admin Portal, then:

  1. Set these values in the application:

    • Entity ID: https://admin.pubnub.com/
    • ACS URL: https://admin.pubnub.com/api/saml/acs?domain=<YOUR_DOMAIN>, where <YOUR_DOMAIN> is your company's email domain.
  2. Configure the IdP to pass these user attributes:

    AttributeRequired
    emailYes
    firstNameYes
    lastNameYes
    companyNameNo
  3. Assign the users who need Admin Portal access to the application.

  4. Download the XML IdP descriptor. It contains the x.509 certificate you need to finish the setup in the Admin Portal.

Request SSO for your organization​

  1. Log in to Admin Portal.
  2. Select your email address in the top-right corner to open the account menu.
  3. Select Organization settings.
  4. Open the SSO tab.
  5. In the Single Sign-On Request form, enter your company name. In Message, include:
    • the PubNub account to enable SSO for
    • the domain to use for SSO
    • the x.509 certificate, if you want to send it now
  6. Select Send request.

The owner of the PubNub account becomes the domain administrator for SSO.

Add the certificate​

After PubNub enables SSO for your domain, open the SSO tab in Organization settings again. If you didn't send the x.509 certificate with your request, upload it there and save your changes.

Log in with SSO​

  1. Go to the Admin Portal login page.
  2. Select SSO.
  3. Enter your company's email domain and select Sign in.
  4. Log in with your IdP credentials.

Was this page useful?

Last updated on