Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support 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 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
    • Environments & Variables
      • Overview
      • Environment Management
      • Using Variables
    • Vault Secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre and Post Processors
      • Assertion
      • Extract Variable
      • Wait
      • Overview
      • Using Scripts
        • Overview
        • Pre Processor Scripts
        • Post Processor Scripts
        • Public Scripts
        • Postman Scripts Reference
        • Calling Other Programming Languages
        • Using JS Libraries
        • Visualizing Responses
        • Script Examples
          • Assertion Scripts
          • Using Variables
          • Modifying Requests
          • Other Examples
      • Database Operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
    • 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 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 Suite
      • Overview
      • Create A Test Suite
      • Orchestrate Test Suite
      • Run Test Suites Locally
      • Run Test Suites Via CLI
      • Scheduled tasks
    • Test Reports
      • Test Reports
    • Test APIs
      • Integration Testing
      • Performance Testing
      • End-to-End Testing
      • Regression Testing
      • Contract Testing
    • Apidog CLI
      • Overview
      • Installing and Running Apidog CLI
      • Apidog CLI Options
    • CI CD
      • Overview
      • Integrate with Github Actions
      • Integrate with Gitlab
      • Integrate with Jenkins
      • Trigger Test by Git Commit
  • 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 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
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
        • Git Connection
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Team Activities
      • Team Roles & Permissions
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Organization
      • Managing Organization
      • Organization Role & Permissions
      • Single Sign-On (SSO)
        • SSO Overview
        • Configuring Microsoft Entra ID
        • Configuring Okta
        • Configuring SSO for an Organization
        • Managing User Accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Introduction to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Plans Management
        • Billing Managers in Organizations
      • Organization Resources
        • Self-Hosted Runner
  • 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
  • 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

Managing Organization

In Apidog, an organization is used to centrally manage multiple teams and members. With organizations, you can control permissions, assign roles, and ensure efficient collaboration across your company.

Creating an Organization#

You can create one or more organizations. To create a new organization:
1.
In the main window, click Organizations from the left navigation panel to open the organization management page.
2.
Click the + New Organization button at the bottom left.
image.png
3.
Enter the organization name.
4.
Click Create. Your new organization is now set up.

Organization Members and Roles#

You can invite members into your organization and assign them different roles:
Org Admin: Has the highest permissions (except the org owner). Can manage organization members, teams, and organization settings.
Org Member: Can join the organization and its teams, and collaborate on projects. Cannot change organization settings.

Inviting Members to the Organization#

As an Organization Owner or Admin, you can directly introduce personnel into the enterprise from the organization level. This is highly suitable for HR or IT departments centrally distributing accounts for onboarding employees.
πŸ’‘ Prerequisite:
Before sending an organization invitation, your organization must have at least one created Team, otherwise there will be nowhere to assign team roles.
To invite members into the organization, go to Members under your organization:
Click Invite, where you can choose an invitation method and grant permissions accordingly:
1.
Invite via Link:
image.png
Organization Role: Generally, new employees are uniformly assigned the Member role.
All Team Roles: While inviting them into the enterprise, you can directly push them into the corresponding subordinate business pools. You can universally set the same role for all teams, or click "Custom" to open details and precisely specify "They only join Team A as a Member, and remain unjoined in Team B".
image.png
2.
Invite via Email (or Bulk Import):
In addition to supporting independent settings for each email and CSV bulk import just like at the team level, you can similarly use the Bulk Config tool at the top to quickly and uniformly configure the Organization Role and specifically assigned Team Roles for this group of people.
image.png

Permissions cascade and Default Role Mapping#

It is crucial to understand that Organization Roles and Team/Project Roles operate on two separate tracks. Understanding how permissions cascadeβ€”or don't cascadeβ€”is essential when assigning roles:
Organization Roles vs. Team Access: Organization Admins have administrative power over the company's structure (e.g., creating teams, managing billing, and overseeing the member directory). However, they do not automatically gain access to API data within individual projects. To access or edit a project, an Org Admin must still be added to the relevant Team or Project.
Team Admin β†’ Project Editor: Users assigned as Team Admins automatically receive Editor permissions for all projects within that team.
Team Member β†’ Project Read-Only: Users assigned as standard Team Members are granted safe, Read-Only access to the team's projects by default.
Forbidden / Unjoined: If a user is not assigned to a team (or set to Forbidden), they receive no project access within that team.
Note:
These are just the initial baseline permissions. Once inside the team, Team Admins can individually adjust project permissions or customize roles based on the actual business needs.

Custom Project Roles#

With the Enterprise plan, you can also use custom project roles to control what project members can do.
Custom roles only support Project level. Organization roles do not currently support customization.

Relation Between Organizations and Teams#

Organization: The highest-level management unit, representing a company or large group. It manages multiple teams.
Teams: A sub-unit within an organization, usually a department or smaller group. It manages multiple projects.

Organization vs. Team β€” Which Should You Choose?#

When using Apidog, a common question is: should you manage everything directly under an Organization, or mainly rely on Teams? The answer really comes down to two things β€” team size and business scope.

If Your Team is Small and Focused#

Say you've got around ten people all working on the same product line. In that case, a single Team is more than enough. A Team can handle projects, APIs, and members in one place β€” simple and efficient, without the extra overhead of an Organization.

If Your Company is Large and Spread Out#

If you've got lots of people and multiple, unrelated business lines, it's best to create an Organization first, then set up separate Teams inside it for each business area. Each Team manages its own projects and members, with clear boundaries and no overlap.

Updating Organization Info#

Admins can update the organization's name or details from Settings. All members will see the updated info.

Transferring the Organization#

The organization owner can transfer ownership to another member via Organization Settings β†’ Danger Zone β†’ Transfer.

Dismissing the Organization#

The organization owner can permanently delete the organization under Organization Settings β†’ Danger Zone β†’ Dismiss Organization.
image.png
WARNING
Dismissing an organization is permanent and cannot be undone. All teams and projects within the organization will be deleted.
Modified atΒ 2026-04-09 08:39:01
Previous
Team Collaboration
Next
Organization Role & Permissions
Built with