API Keys & Integrations

PubPerf provides API keys for programmatic access and supports SAML-based Single Sign-On (SSO) for enterprise authentication.

API Keys

API keys allow you to integrate PubPerf data with your own systems, scripts, or third-party tools.

Creating an API Key

1. Navigate to Connect > API from the sidebar.
2. Click Create API Key.
3. Give your key a descriptive name.
4. Copy the generated key — it will only be shown once.

Managing API Keys

• Regenerate — Generate a new secret for an existing API key. The old key will immediately stop working.
• Enable/Disable — Toggle a key's active status without deleting it.
• Delete — Permanently remove an API key.

Best Practices

• Use separate API keys for different applications or environments.
• Rotate keys periodically for security.
• Disable keys immediately if they may have been compromised.
• Never expose API keys in client-side code or public repositories.

SAML Single Sign-On

Enterprise organizations can configure SAML-based SSO to allow team members to authenticate using their existing identity provider (IdP).

Configuring SAML

1. Navigate to Connect > SAML from the sidebar.
2. Enter your Identity Provider's SAML metadata:
   • SSO URL — Your IdP's Single Sign-On endpoint.
   • Entity ID — Your IdP's entity identifier.
   • Certificate — The X.509 certificate from your IdP.
3. Save the configuration.

Once configured, team members can log in using the SSO option on the login page. The SSO URL is unique to your organization.

Connection Overview

The Connect page provides a summary of all active integrations for your organization, including the number of API keys in use and SAML configuration status.