Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Managing teams
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Navigating Apidog
    • Basic concepts in Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration to Apidog
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Organization method of endpoints
    • Endpoint basics
    • Module
    • Configure multiple request body examples
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Schemas
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
      • oneOf, allOf, anyOf
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique identification
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environment Management
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 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 in scripts
          • Using scripts to modify request messages
          • 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)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Sync data from endpoints/endpoint cases
      • Import endpoints/endpoint cases from other projects
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Github Actions
      • Integrate with Jenkins
      • Integrate with Gitlab
      • Trigger Test by Git Commit
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Markdown documentations
    • Publish docs sites
    • Custom layouts
    • Custom CSS, JavaScript, HTML
    • Custom domain
    • LLM-friendly Features
    • SEO settings
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics with Doc Sites
      • Folder tree settings
      • Visibility settings
      • Embedding values in document URLs
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • SSE debugging
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP/WebService
    • GraphQL
    • gRPC
    • Use request proxy agents for debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • AI Features
    • Overview
    • Enable AI features
    • Modify schemas with AI
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect API Specification within Apidog Project to AI via Apidog MCP Server
    • Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Connect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Offline Space
    • Overview
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing teams
      • Managing Teams
      • Managing team members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
        • Git Connection
    • Managing organization
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
      • Plans management
        • Billing managers in organization
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
    • How to move a paid team to a organization?
  • Data & Security
    • Where is Apidog's data stored, and how is data security ensured?
    • How is user data stored? Will this data be public? Or will it be private? Will all data be stored in the cloud?
    • When sending requests, do they go through the Apidog server? Is data security ensured?
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • 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.

Inviting users to join the team#

To invite members, go to Members and click on Invite at the top right.
Tip
Only team admins and team owner can send invitations. Project admins, even if they manage a specific project, cannot invite members to the team.
inviting-users-to-teams.jpg

Invitation methods#

There are two methods to invite members to the team:
Invite via Link: Copy the invitation link and share it with users to join the team. When joining through this link:
The user's team role is automatically set toTeam Member.
Their permissions for all team projects are determined by the project role you assign during the invitation.
invite-team-users-via-link.png
Invite via Email: Enter one or more email addresses and send an invitation.
Apidog will email the recipients, prompting them to register (if they are not Apidog users yet) and join the team.
Their permissions for all team projects are determined by the project role you assign during the invitation.
invite-team-users-via-email.png

Inviting users to join specific projects#

Users with invitation permissions can invite external collaborators to edit specific projects without granting access to other team projects. To do so, click on Invite on the left side of the project page.
invite-team-users-join-specific-projects.jpg
There are two ways to invite other users to join the current project, and these methods are the same as those used for inviting users to the team. But:
Invitations sent from a project are limited to that project only.
For other projects in the team, permissions default toForbidden, meaning the invited member cannot view them.
inviting-users-join-project.jpg

Guests#

Users who gain project access through "Project Invitations" are considered guests at the team level.
Guests can only see the projects they're invited to. Use "Project Invitations" to allow external collaborators to edit specific projects without accessing other team projects.
Guests have the same team permissions as team members, but are excluded from permission settings for newly created team projects.
NOTE
Guests are also counted as team members and will be billed according to the total number of team members.

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#

If your team is not part of an organization, 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.
For instructions on setting a billing manager in an organization, see Billing managers in organization.
image.png

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.
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 2025-08-12 03:55:41
Previous
Managing Teams
Next
Member Roles & Permission Settings
Built with