Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. Managing Organization
  • Apidog Learning Center
  • Getting Started
    • Introduction to Apidog
    • Basic Concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Creating an Endpoint
      • Making a Request
      • Adding an Assertion
      • Creating Test Scenarios
      • Sharing API Documentation
      • Explore More
    • Migration to Apidog
      • Overview
      • Manual Import
      • Scheduled Import (Bind Data Sources)
      • Import Options
      • Export Data
      • Import From
        • Import from Postman
        • Import from Stoplight
        • Import OpenAPI Spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har File
        • Import WSDL
  • Design APIs
    • Overview
    • Create a New API Project
    • Endpoint Basics
    • APl Design Guidelines
    • Module
    • Configure Multiple Request Body Examples
    • Components
    • Common Fields
    • Global Parameters
    • Endpoint Change History
    • Comments
    • Batch Endpoint Management
    • Custom Protocol API
    • Spec-first Mode (Beta)
    • Schemas
      • Overview
      • Create a New Schema
      • Build a Schema
      • Generate Schemas from JSON Etc
      • oneOf, allOf, anyOf
      • Using Discriminator
    • Security Schemes
      • Overview
      • Create a Security Scheme
      • Use the Security Scheme
      • Security Scheme in Online Documentation
    • Advanced Features
      • Custom Endpoint Fields
      • Associated Test Scenarios
      • Endpoint Status
      • Appearance of Parameter Lists
      • Endpoint Unique Identification
  • Develop and Debug APIs
    • Overview
    • Generating Requests
    • Sending Requests
    • Debugging Cases
    • Test Cases
    • Dynamic Values
    • Validating Responses
    • Design-First vs Request-First
    • Generating Code
    • AI Debugging
      • AI Agent Debugger
      • A2A Debugger
    • Environments & Variables
      • Overview
      • Using Variables
      • Environment Management
    • Vault Secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre and Post Processors
      • Overview
      • Assertion
      • Extract Variable
      • Wait
      • Security
      • Database Operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Using Scripts
        • Overview
        • Pre Processor Scripts
        • Post Processor Scripts
        • Script Library
        • Postman Scripts Reference
        • Calling Other Programming Languages
        • Using JS Libraries
        • Visualizing Responses
        • Script Examples
          • Assertion Scripts
          • Using Variables
          • Modifying Requests
          • Other Examples
    • Dynamic Values Modules
  • Mock API Data
    • Overview
    • Smart Mock
    • Custom Mock
    • Mock Priority Sequence
    • Mock Scripts
    • Cloud Mock
    • Self-Hosted Runner Mock
    • Mock Language (Locales)
  • API Testing
    • Overview
    • Test Reports
      • Test Reports
    • Test Scenarios
      • Create a Test Scenario
      • Pass Data Between Requests
      • Flow Control Conditions
      • Sync Data from Endpoints and Endpoint Cases
      • Import Endpoints and Endpoint Cases from Other Projects
      • Export Test Scenarios
    • Run Test Scenarios
      • Run a Test Scenario
      • Run Test Scenarios in Batch
      • Data-Driven Testing
      • Shared Test Data
      • Scheduled Tasks
      • Manage Runtime Environment of APIs from Other Projects
    • Test APIs
      • Integration Testing
      • Performance Testing
      • End-to-End Testing
      • Regression Testing
      • Contract Testing
    • Test Suite
      • Overview
      • Create A Test Suite
      • Orchestrate Test Suite
      • Run Test Suites Locally
      • Scheduled Tasks
  • Apidog CLI
    • Overview
    • Installing and Running Apidog CLI
    • Run Test Suites Via CLI
    • Use Apidog CLI with an AI Agent
    • Apidog CLI Commands & Options
    • CI CD
      • Overview
      • Trigger Test by Git Commit
      • Integrate with Github Actions
      • Integrate with Gitlab
      • Integrate with Jenkins
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick Share
    • Viewing API Documentation
    • Markdown Documentation
    • Publishing Documentation Sites
    • Custom Login Page
    • Custom Layouts
    • Custom CSS, JavaScript, HTML
    • Custom Domain
    • AI Features
    • SEO Settings
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics
      • Folder Tree Settings
      • Visibility Settings
      • Embedding Values in Document URLs
    • API Versions
      • Overview
      • Creating API Versions
      • Publishing API Versions
      • Sharing Endpoints with API Versions
  • Send Requests
    • Overview
    • SSE Debugging
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP or WebService
    • GraphQL
    • gRPC
    • Use Request Proxy Agents for Debugging
    • Create Requests
      • Request History
      • Request Basics
      • Parameters and Body
      • Request Headers
      • Request Settings
      • Debug Requests
      • Saving Requests as Endpoints
      • HTTP/2
    • Response and Cookies
      • Viewing API Responses
      • Managing Cookies
      • Overview
    • Authentication and Authorization
      • Overview
      • CA and Client Certificates
      • Authorization Types
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
  • Branches
    • Overview
    • Creating a Sprint Branch
    • Testing APIs in a Branch
    • Designing APIs in a Branch
    • Merging Sprint Branches
    • Managing Sprint Branches
    • AI Branch (Beta)
  • AI Features
    • Overview
    • Enabling AI Features
    • Generating Test Cases
    • Modifying Schemas with AI
    • Endpoint Compliance Check
    • API Documentation Completeness Check
    • AI-Powered Field Naming
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect Apidog Project to AI
    • Connect Published Documentation to AI
    • Connect OpenAPI Files to AI
  • Best Practices
    • Handling API Signatures
    • Accessing OAuth 2.0 Protected APIs
    • Collaboration Workflow
    • Managing Authentication State
  • Offline Space
    • Overview
  • Administration
    • Basic Concepts
    • Enterprise Onboarding
      • Enterprise Onboarding Journey
      • Set Up Secure Enterprise Access
      • Migrate and Validate Your API Data
      • Establish Your Team’s Apidog Workflow
    • Managing Projects
      • Notification Settings
      • Managing Projects
      • Managing Project Members
      • Project Resources
        • Database Connection
        • Git Connection
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Team Roles & Permissions
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Organization
      • Managing Organization
      • Managing Teams in an Organization
      • Organization Role & Permissions
      • Audit Logs
      • Enterprise Policies
      • Organization API Hub
      • Single Sign-On (SSO)
        • SSO Overview
        • Configuring SSO for an Organization
        • Managing User Accounts
        • Configuring Microsoft Entra ID
        • Configuring Okta
        • Configuring JumpCloud SSO
        • SAML Group Mapping to Teams
      • SCIM Provisioning
        • Introduction to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Plans Management
        • Billing Managers in Organizations
      • Organization Resources
        • Self-Hosted Runner
        • GitHub Enterprise Cloud
  • Billing
    • Overview
    • Credits
    • Upgrading Your Plan
    • Alternative Payment Methods
    • Managing Subscriptions
    • Moving Paid Teams to Organizations
  • Data & Security
    • Data Storage and Security
    • User Data Privacy and Security
    • Request Routing and Data Security
    • Secret Scanner
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA Plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request Proxy in Web
      • Request Proxy in Shared Docs
      • Request Proxy in Client
  • Account & Preferences
    • Account Settings
    • Generating OpenAPI Access Token
    • Notification
    • Language Settings
    • Hot Keys
    • Network Proxy Configuration
    • Backing Up Data
    • Updating Apidog
    • Deleting Account
    • Experimental Features
  • References
    • API Design-First Approach
    • Apidog OpenAPI Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Installing Java Environment
    • Runner Deployment Environment
    • Apidog Markdown Syntax
    • Apidog Swagger Extensions
      • Overview
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema Extensions
      • Overview
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Managing Organization

Organization API Hub

An Organization API Hub brings your organization's published API documentation together in one place. Readers can browse participating documentation sites and search across them without opening each site separately. Organization administrators manage the Hub's branding, publication status, access settings, and search index.
Unlike the public Apidog API Hub, which helps developers discover APIs contributed by the community, an Organization API Hub collects documentation from your own organization.
image.png

Prerequisites#

Apidog 2.8.54 or later.
An organization on the Enterprise plan in Apidog SaaS. This page covers the SaaS Organization API Hub.
Organization administrator permissions to configure and publish the Hub.
Published main documentation sites belonging to the organization, with a site administrator available to opt each site into the Hub.
Organization SAML SSO configured if you want to restrict Hub access using SSO. See Configuring SSO for an Organization.

Set Up the Hub#

Open your organization's API Hub settings to configure the Hub.
1.
Set the Hub's name and icon so readers can identify your organization.
2.
Configure the Hub's domain. You can use its provided address or configure a custom domain.
3.
Choose public or organization SSO access, as described below.
4.
Save your settings and enable publication when the Hub is ready to share.
image.png

Choose Who Can Access the Hub#

Access modeReader experience
PublicAnyone with the Hub link can open it. Public search includes only publicly visible content.
Organization SSOReaders authenticate through the organization's configured SAML SSO. Participating sites follow the Hub's access policy.
Choose the access mode before sharing the Hub link. Adding documentation to the organization Hub is separate from contributing it to the public Apidog community API Hub.
image.png

Add Documentation Sites#

Sites must opt into the organization Hub; publishing a site alone does not automatically add it.
For each site:
1.
Open the project and go to Publish Docs.
2.
Select the project's main site. If it has not been published, follow Publishing Documentation Sites.
3.
In the site's publishing settings, select the option to follow the organization API Hub and save the configuration. The participating site inherits the Hub's access policy.
4.
Open the published Hub and check that the site appears in its catalog.
Only published main sites belonging to the organization are eligible. Sub-sites, unpublished sites, and deleted sites are excluded. Each site's administrator controls whether it participates.
image.png

Browse and Search Documentation#

Share the published Hub URL with your readers. They can browse its catalog and open the documentation they need. Search lets them find content across participating sites from one place.
Public search includes publicly visible content. Authenticated Hub search covers content included in the Hub. Organization administrators can rebuild the search index when needed.
image.png

Maintain the Hub#

Update branding or access: Return to the organization's API Hub settings to update its configuration.
Review participating sites: Check that each site is published, belongs to the organization, and is opted into the Hub.
Refresh search: Use the Hub's search-index rebuild action when the index needs refreshing.
Stop publication: Turning off the Hub also affects access to documentation sites that follow it. Review those sites before disabling publication.

A Site Is Missing from the Hub#

Check that:
The site belongs to a project in the same organization.
It is the main site, not a sub-site.
It is published and has not been deleted.
Its administrator has enabled participation in the organization Hub.
If the site is listed but its content is missing from search, review its visibility and rebuild the Hub's search index as needed.
Modified at 2026-11-16 10:30:36
Previous
Enterprise Policies
Next
SSO Overview
Built with