Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Managing Teams
  • 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 Teams

Managing Team Members

The member management feature in Apidog enables you to manage user collaboration within your team by assigning specific permissions. Only team owner and admins have the authority to manage these settings. Other team members can view the list of team members and their basic information but cannot make any changes.
When you need to collaborate on an API project, you can invite team members or external collaborators to work together.
Where Should You Invite?
Invite to Team (Current Page): Best for internal colleagues or full-time developers who need broad access to multiple projects within the team.
Invite to Project: Best for external collaborators or outsourced personnel. If you want to strictly restrict a user to a single specific project without granting them visibility into other team assets, please invite them directly from the project level. See Managing Project Members for details.

Invite Members to a Team#

To invite members, go to Members and click on Invite at the top right.
Only members with the appropriate permissions (such as Team Owner or Team Admin) can invite new members to join the team.
inviting-users-to-teams.jpg

Configure Invitation Details and Send#

The new invitation feature supports highly flexible, parallel permission delegation. Here, you can simultaneously configure the invitee's Team Role and specific Project Permissions:

Method 1: Invite via Link#

Using a link allows any member who receives it to join the team autonomously, which is very suitable for mass distribution in internal messaging tools (like Slack or Microsoft Teams).
image.png
Team Role: Determines their management permissions within the team (e.g., Team Member or Team Admin).
All Projects: Sets a default uniform permission (e.g., Editor or Read-only) across all API projects within the team. You can also select "Custom" to define exceptions for specific core projects.
Granting access to a single project?
If you only intend to add external collaborators to one specific project, we highly recommend using Project-level Invitations instead to ensure proper data isolation.
Once configured, click "Copy Link" to distribute the invitation.

Method 2: Invite via Email (or Bulk Import)#

This method is recommended when you need to set distinct permissions for different batches of new members.
image.png
Enter the invitees' emails directly into the input box (separated by Commas or Enter).
Independent Control: The list automatically generates a permission bar for each email. This allows for diverse setups in one go (e.g., granting User A Team Admin access while restricting User B to Read-only).
Bulk Import: Click the bulk import button to upload a CSV file (up to 50 emails per batch). Once extracted, use the Bulk Config menu at the top to apply identical permissions to all imported users instantly.
Granting access to a single project?
To restrict invitees to one specific project only, please use Project-level Invitations instead.

Managing Team Member Details & Permissions#

Click the settings button on the right of a member's name to open the member details page.
member-setting-page-entry.jpg
There, you can configure more advanced settings.
manage-member-details.jpg
1.
Nickname: Assign a nickname for easier identification. The member can also change it.
2.
Role: Set a member's team role to control their access to team functions, such as inviting or removing members and creating projects.
New members are assigned the "Team Member" role by default.
Be cautious when assigning "Team Admin" roles, as it can impact data security.
3.
Project Role: Set the member's role for each project in the team, defining what they can do in each project. Check out member roles & permission settings.
4.
Remove Member: You can remove members from the team. Once removed, they will no longer have access to your team's data.

Billing Managers#

You can assign the "Billing Manager" role to certain users so they can help your team upgrade plans, purchase seats, and manage other billing activities. Billing Manager is an independent role.
For instructions on setting a billing manager in an organization, see Billing managers in organization.

Managing Billing Managers in a Team#

Only team owners, admins, or current billing managers can invite other users to join the team as a "Billing Manager".
At the bottom of the "Plans Management" page in your team, you can view the current billing managers list and manage them.
image.png
Click the Invite button to open a pop-up window. Enter one or more email addresses. An invitation to become a billing manager will be sent to those emails. The invitee must log in to the Apidog account linked to the invitation email and accept the invitation to officially join the team as a billing manager. Invitations are valid for 7 days and cannot be used after they expire.
image.png
From the billing managers list, you can remove a specific billing manager. Once you click Remove and confirm, that billing manager will no longer have access to the team in this role.
image.png

Billing Manager Permissions#

Billing managers will have the ability to:
βœ… View the usage dashboard
βœ… Upgrade, renew, expand, or change the paid plan
βœ… Add, update, or remove payment methods
βœ… View payment history
βœ… Request invoices
βœ… View a list of billing managers
βœ… Invite additional billing managers
βœ… Remove other existing billing managers
Billing managers will not be able to:
❌ Create, access, or modify projects, resources, activities, or settings within your team
❌ See members of your team
❌ Be seen in the list of team members
In the product interface, if you access a team as a billing manager, you will only see the "Plans Management" page for that team, as shown below:
image.png

Notes#

1.
To invite a user as a billing manager, you need an email address registered with an Apidog account:
If the email is already registered with Apidog, the user can log in and accept the invitation to join as a billing manager
If the email is not registered, the user will be prompted to sign up for an Apidog account, log in, and then join as a billing manager
If you log in with a different Apidog account (not linked to the invited email), you'll see an "Invalid Invitation Link" warning when accepting the invite. This helps prevent misuse and ensures security
2.
A team can have multiple billing managers. They can remove each other from the team and invite new billing managers.
3.
A user can be both a regular team member (e.g., admin, member, etc.) and a billing manager. In that case, their permissions in the team will be the combined set of both roles.
Modified atΒ 2026-04-09 08:10:11
Previous
Managing Teams
Next
Team Activities
Built with